Docs/defensive-coding-guide
2
0
Fork 0
Code Issues 3 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Fix accidental formatting in monospaced text

Browse source 
Monospaced text in AsciiDoc can contain italics, bold, and other
formatted text. Using `+text+` instead of `text` makes the wrapped text
treated as literal monospace text, resolving this issue. [1] Use this
construct when double underscores are present in monospaced text to
avoid accidental formatting.

[1]: https://docs.asciidoctor.org/asciidoc/latest/text/literal-monospace
This commit is contained in:
Jared Kangas 2024-09-06 14:28:40 -07:00
parent e435151a0c
commit a46127f8a9
3 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
modules/ROOT/pages/programming-languages/C.adoc
View file

@ -770,7 +770,7 @@ are not implemented as inline functions or preprocessor macros.
The compiler lacks knowledge of such wrappers outside the The compiler lacks knowledge of such wrappers outside the
translation unit which defines them, which means that some translation unit which defines them, which means that some
optimizations and security checks are not performed. Adding optimizations and security checks are not performed. Adding
`__attribute__` annotations to function `+__attribute__+` annotations to function
declarations can remedy this to some extent, but these declarations can remedy this to some extent, but these
annotations have to be maintained carefully for feature parity annotations have to be maintained carefully for feature parity
with the standard implementation. with the standard implementation.
@ -788,7 +788,7 @@ propagate its return value, your wrapper should be declared
with `warn_unused_result` as well. with `warn_unused_result` as well.
* Duplicating the buffer length checks based on the * Duplicating the buffer length checks based on the
`__builtin_object_size` GCC builtin is `+__builtin_object_size+` GCC builtin is
desirable if the wrapper processes arrays. (This desirable if the wrapper processes arrays. (This
functionality is used by the functionality is used by the
`-D_FORTIFY_SOURCE=2` checks to guard `-D_FORTIFY_SOURCE=2` checks to guard

2
modules/ROOT/pages/programming-languages/Java.adoc
View file

@ -375,7 +375,7 @@ necessarily constant during the lifetime of your JNI module.
Storing it in a global variable is therefore incorrect. Storing it in a global variable is therefore incorrect.
Particularly if you are dealing with callbacks, you may have to Particularly if you are dealing with callbacks, you may have to
store the pointer in a thread-local variable (defined with store the pointer in a thread-local variable (defined with
`__thread`). It is, however, best to avoid the `+__thread+`). It is, however, best to avoid the
complexity of calling back into Java code. complexity of calling back into Java code.
Keep in mind that C/C++ and Java are different languages, Keep in mind that C/C++ and Java are different languages,

6
modules/ROOT/pages/tasks/Tasks-Processes.adoc
View file

@ -266,8 +266,8 @@ variables.
The Autoconf macro `AC_GNU_SOURCE` ensures this. The Autoconf macro `AC_GNU_SOURCE` ensures this.
* Check for the presence of the `secure_getenv` * Check for the presence of the `secure_getenv`
and `__secure_getenv` function. The Autoconf and `+__secure_getenv+` function. The Autoconf
directive `AC_CHECK_FUNCS([__secure_getenv secure_getenv])` directive `+AC_CHECK_FUNCS([__secure_getenv secure_getenv])+`
performs these checks. performs these checks.
* Arrange for a proper definition of the * Arrange for a proper definition of the
@ -286,7 +286,7 @@ restrictions or cause a privileged process to behave in an
unexpected way. unexpected way.
Either the `secure_getenv` function or the Either the `secure_getenv` function or the
`__secure_getenv` is available from GNU libc. `+__secure_getenv+` is available from GNU libc.
[[ex-Defensive_Coding-Tasks-secure_getenv]] [[ex-Defensive_Coding-Tasks-secure_getenv]]
.Obtaining a definition for `secure_getenv` .Obtaining a definition for `secure_getenv`