Skip to content

Commit

Permalink
move headers into their own subfolders
Browse files Browse the repository at this point in the history
  • Loading branch information
uucidl committed May 31, 2014
1 parent a323dbe commit 5c330cf
Show file tree
Hide file tree
Showing 13 changed files with 1,043 additions and 1,041 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ See:

## Usage

Check include/spdr.h it is hopefully small enough to be sufficient as documentation.
Check include/spdr/spdr.h it is hopefully small enough to be sufficient as documentation.

Check examples/ for some typical uses.

Expand All @@ -45,7 +45,7 @@ With:
```

This will trace the printf call and associate a textual argument to
it.
it.

Argument keys, categories and names are meant to be litteral or last for the duration of your instrument program, so as to limit their number. Traces where these values would grow with time would become hard to read and understand. Any time varying data should be kept in argument values (such as the "Hello, world." string above)

Expand All @@ -67,20 +67,20 @@ console.
```C
static void report(const char* line, void* user_data)
{
FILE* file = user_data;
FILE* file = user_data;

fputs(line, file);
fputs(line, file);
}

static void foo()
{
/* ... */
/* ... */

FILE* f = fopen("traces.json", "wb");
if (f) {
spdr_report(gbl_spdr, SPDR_CHROME_REPORT, report, f);
fclose(f);
}
FILE* f = fopen("traces.json", "wb");
if (f) {
spdr_report(gbl_spdr, SPDR_CHROME_REPORT, report, f);
fclose(f);
}
```
## Compilation
Expand All @@ -106,7 +106,7 @@ project and importing the header found in include/ should basically be
sufficient.
Use of the library in C++ is supported, you must include the
include/spdr.hh header rather than spdr.h.
include/spdr/spdr.hh header rather than spdr.h.
## Implementation & Design
Expand Down Expand Up @@ -144,8 +144,8 @@ elapsed microseconds, overriding the default internal one.
See:
```C
void spdr_set_clock_microseconds_fn(struct SPDR_Context *context,
unsigned long long (*clock_microseconds_fn)(void* user_data),
void *user_data);
unsigned long long (*clock_microseconds_fn)(void* user_data),
void *user_data);
```
## Additional Contributors

Expand Down
26 changes: 13 additions & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ See:

## Usage

Check include/spdr.h it is hopefully small enough to be sufficient as documentation.
Check include/spdr/spdr.h it is hopefully small enough to be sufficient as documentation.

Check examples/ for some typical uses.

Expand All @@ -45,7 +45,7 @@ With:
```

This will trace the printf call and associate a textual argument to
it.
it.

Argument keys, categories and names are meant to be litteral or last for the duration of your instrument program, so as to limit their number. Traces where these values would grow with time would become hard to read and understand. Any time varying data should be kept in argument values (such as the "Hello, world." string above)

Expand All @@ -67,20 +67,20 @@ console.
```C
static void report(const char* line, void* user_data)
{
FILE* file = user_data;
FILE* file = user_data;

fputs(line, file);
fputs(line, file);
}

static void foo()
{
/* ... */
/* ... */

FILE* f = fopen("traces.json", "wb");
if (f) {
spdr_report(gbl_spdr, SPDR_CHROME_REPORT, report, f);
fclose(f);
}
FILE* f = fopen("traces.json", "wb");
if (f) {
spdr_report(gbl_spdr, SPDR_CHROME_REPORT, report, f);
fclose(f);
}
```
## Compilation
Expand All @@ -106,7 +106,7 @@ project and importing the header found in include/ should basically be
sufficient.
Use of the library in C++ is supported, you must include the
include/spdr.hh header rather than spdr.h.
include/spdr/spdr.hh header rather than spdr.h.
## Implementation & Design
Expand Down Expand Up @@ -144,8 +144,8 @@ elapsed microseconds, overriding the default internal one.
See:
```C
void spdr_set_clock_microseconds_fn(struct SPDR_Context *context,
unsigned long long (*clock_microseconds_fn)(void* user_data),
void *user_data);
unsigned long long (*clock_microseconds_fn)(void* user_data),
void *user_data);
```
## Additional Contributors

Expand Down
2 changes: 1 addition & 1 deletion examples/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ CFLAGS+=-lm $(LIB_LIBS)

all: without-tracing with-tracing mt-with-tracing mt-without-tracing cxx-tracing perf-tracing perf-without-tracing
clean:
rm -f *-tracing $(LIB)
rm -f *-tracing $(LIB) ../src/*.o

$(LIB): $(LIB_SRC:%.c=%.o)
ar rcs $@ $^
Expand Down
Loading

0 comments on commit 5c330cf

Please sign in to comment.