Skip to content

Commit

Permalink
docs: use footnotes
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiud committed Jun 12, 2024
1 parent 5cf7a9a commit c4b63c7
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
14 changes: 10 additions & 4 deletions docs/failures.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,13 @@ int main(int argc, char* argv[]) {
```

By default, glog tries to dump the stacktrace and calls `#!cpp std::abort`. The
stacktrace is generated only when running the application on a system supported
by glog. Currently, glog supports x86, x86_64, PowerPC architectures,
`libunwind`, and the Debug Help Library (`dbghelp`) on Windows for extracting
the stack trace.
stacktrace is generated only when running the application on a system
supported[^1] by glog.

[^1]: To extract the stack trace, glog currently supports the following targets:

* x86, x86_64,
* PowerPC architectures,
* `libunwind`,
* and the Debug Help Library (`dbghelp`) on Windows.

6 changes: 3 additions & 3 deletions docs/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ google::FlushLogFiles(google::GLOG_ERROR);
```

If you don't need `ERROR` defined by `windows.h`, there are a couple of more
workarounds which sometimes don't work:
workarounds which sometimes don't work[^1]:

- `#!cpp #define WIN32_LEAN_AND_MEAN` or `NOGDI` **before**
`#!cpp #include <windows.h>`.
- `#!cpp #undef ERROR` **after** `#!cpp #include <windows.h>`.

See [this issue](http://code.google.com/p/google-glog/issues/detail?id=33) for
more detail.
[^1]: For more information refer to [this
issue](http://code.google.com/p/google-glog/issues/detail?id=33).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- pymdownx.details
- pymdownx.highlight:
Expand Down

0 comments on commit c4b63c7

Please sign in to comment.