From: Wu Yongwei <wuyongwei@gmail.com>
Date: Tue, 1 Nov 2022 13:48:24 +0000 (+0800)
Subject: Fix Markdown issues
X-Git-Tag: v0.14.0~13^2~5
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=72886af724b546cd14c682af93c88bfe59998015;p=userspace-rcu.git

Fix Markdown issues

`_`, `<`, and `>` are special characters in Markdown, and need to be
escaped except in code blocks.  So backticks or backslahes are used to
fix the apparent issues, which caused wrong rendering.

Signed-off-by: Wu Yongwei <wuyongwei@gmail.com>
---

diff --git a/README.md b/README.md
index 1e75589..f75af60 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,7 @@ Architectures supported
 Currently, the following architectures are supported:
 
   - x86 (i386, i486, i586, i686)
-  - amd64 / x86_64
+  - amd64 / x86\_64
   - PowerPC 32/64
   - S390, S390x
   - ARM 32/64
@@ -163,8 +163,8 @@ There are multiple flavors of liburcu available:
   - `signal`,
   - `bp`.
 
-The API members start with the prefix "urcu_<flavor>_", where
-<flavor> is the chosen flavor name.
+The API members start with the prefix `urcu_<flavor>_`, where
+`<flavor>` is the chosen flavor name.
 
 
 ### Usage of `liburcu-memb`
@@ -385,8 +385,8 @@ For always-on debugging self-checks:
 	./configure --enable-rcu-debug
 
 For fine grained enabling of debugging self-checks, build
-userspace-rcu with DEBUG_RCU defined and compile dependent
-applications with DEBUG_RCU defined when necessary.
+userspace-rcu with `DEBUG_RCU` defined and compile dependent
+applications with `DEBUG_RCU` defined when necessary.
 
 Warning: Enabling this feature result in a performance penalty.
 
@@ -445,7 +445,7 @@ applications built using Userspace RCU 0.10 headers linked against
 Userspace RCU 0.11 or 0.12 shared objects. The problem occurs as
 follows:
 
-  - An application executable is built with _LGPL_SOURCE defined, includes
+  - An application executable is built with `_LGPL_SOURCE` defined, includes
     any of the Userspace RCU 0.10 urcu flavor headers, and is built
     without the -fpic compiler option.
 
diff --git a/doc/cds-api.md b/doc/cds-api.md
index 5bc615e..3e0fe8b 100644
--- a/doc/cds-api.md
+++ b/doc/cds-api.md
@@ -38,7 +38,7 @@ for implementing hash tables. Downside over rculist.h: lookup of tail in O(n).
 
 ### `urcu/wfstack.h`
 
-Stack with wait-free push and wait-free pop_all. Both
+Stack with wait-free push and wait-free pop\_all. Both
 blocking and non-blocking pop and traversal operations are provided. This
 stack does _not_ specifically rely on RCU. Various synchronization techniques
 can be used to deal with pop ABA. Those are detailed in the API.
@@ -59,7 +59,7 @@ traversal (see API for details).
 
 ### `urcu/lfstack.h`
 
-Stack with lock-free push, lock-free pop, wait-free pop_all,
+Stack with lock-free push, lock-free pop, wait-free pop\_all,
 wait-free traversal. Various synchronization techniques can be
 used to deal with pop ABA. Those are detailed in the API.
 This stack does _not_ specifically rely on RCU.
diff --git a/doc/solaris-build.md b/doc/solaris-build.md
index a5bbdef..8baf305 100644
--- a/doc/solaris-build.md
+++ b/doc/solaris-build.md
@@ -20,7 +20,7 @@ And the following OpenCSW packages are required :
 * gsed
 * gmake
 * pkgconfig
-* libglib2_dev
+* libglib2\_dev
 * gcc4core
 
 ### Build