diff mbox series

[v5,3/4] docs: (further further) remove non-reference uses of single backticks

Message ID 20211102184400.1168508-4-jsnow@redhat.com (mailing list archive)
State New, archived
Headers show
Series docs/sphinx: change default `role` to "any" | expand

Commit Message

John Snow Nov. 2, 2021, 6:43 p.m. UTC
Signed-off-by: John Snow <jsnow@redhat.com>
---
 docs/devel/build-system.rst | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

Comments

Thomas Huth Nov. 3, 2021, 6:41 a.m. UTC | #1
On 02/11/2021 19.43, John Snow wrote:
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>   docs/devel/build-system.rst | 21 +++++++++++----------
>   1 file changed, 11 insertions(+), 10 deletions(-)
> 
> diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst
> index 7f106d2f1c..48e56d7ea9 100644
> --- a/docs/devel/build-system.rst
> +++ b/docs/devel/build-system.rst
> @@ -47,16 +47,17 @@ command line options for which a same-named Meson option exists;
>   dashes in the command line are replaced with underscores.
>   
>   Many checks on the compilation environment are still found in configure
> -rather than `meson.build`, but new checks should be added directly to
> -`meson.build`.
> +rather than ``meson.build``, but new checks should be added directly to
> +``meson.build``.
>   
>   Patches are also welcome to move existing checks from the configure
> -phase to `meson.build`.  When doing so, ensure that `meson.build` does
> -not use anymore the keys that you have removed from `config-host.mak`.
> -Typically these will be replaced in `meson.build` by boolean variables,
> -``get_option('optname')`` invocations, or `dep.found()` expressions.
> -In general, the remaining checks have little or no interdependencies,
> -so they can be moved one by one.
> +phase to ``meson.build``.  When doing so, ensure that ``meson.build``
> +does not use anymore the keys that you have removed from
> +``config-host.mak``.  Typically these will be replaced in
> +``meson.build`` by boolean variables, ``get_option('optname')``
> +invocations, or ``dep.found()`` expressions.  In general, the remaining
> +checks have little or no interdependencies, so they can be moved one by
> +one.
>   
>   Helper functions
>   ----------------
> @@ -298,7 +299,7 @@ comprises the following tasks:
>   
>    - Add code to perform the actual feature check.
>   
> - - Add code to include the feature status in `config-host.h`
> + - Add code to include the feature status in ``config-host.h``
>   
>    - Add code to print out the feature status in the configure summary
>      upon completion.
> @@ -334,7 +335,7 @@ The other supporting code is generally simple::
>   
>   For the configure script to parse the new option, the
>   ``scripts/meson-buildoptions.sh`` file must be up-to-date; ``make
> -update-buildoptions`` (or just `make`) will take care of updating it.
> +update-buildoptions`` (or just ``make``) will take care of updating it.
>   
>   
>   Support scripts
> 

Reviewed-by: Thomas Huth <thuth@redhat.com>
diff mbox series

Patch

diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst
index 7f106d2f1c..48e56d7ea9 100644
--- a/docs/devel/build-system.rst
+++ b/docs/devel/build-system.rst
@@ -47,16 +47,17 @@  command line options for which a same-named Meson option exists;
 dashes in the command line are replaced with underscores.
 
 Many checks on the compilation environment are still found in configure
-rather than `meson.build`, but new checks should be added directly to
-`meson.build`.
+rather than ``meson.build``, but new checks should be added directly to
+``meson.build``.
 
 Patches are also welcome to move existing checks from the configure
-phase to `meson.build`.  When doing so, ensure that `meson.build` does
-not use anymore the keys that you have removed from `config-host.mak`.
-Typically these will be replaced in `meson.build` by boolean variables,
-``get_option('optname')`` invocations, or `dep.found()` expressions.
-In general, the remaining checks have little or no interdependencies,
-so they can be moved one by one.
+phase to ``meson.build``.  When doing so, ensure that ``meson.build``
+does not use anymore the keys that you have removed from
+``config-host.mak``.  Typically these will be replaced in
+``meson.build`` by boolean variables, ``get_option('optname')``
+invocations, or ``dep.found()`` expressions.  In general, the remaining
+checks have little or no interdependencies, so they can be moved one by
+one.
 
 Helper functions
 ----------------
@@ -298,7 +299,7 @@  comprises the following tasks:
 
  - Add code to perform the actual feature check.
 
- - Add code to include the feature status in `config-host.h`
+ - Add code to include the feature status in ``config-host.h``
 
  - Add code to print out the feature status in the configure summary
    upon completion.
@@ -334,7 +335,7 @@  The other supporting code is generally simple::
 
 For the configure script to parse the new option, the
 ``scripts/meson-buildoptions.sh`` file must be up-to-date; ``make
-update-buildoptions`` (or just `make`) will take care of updating it.
+update-buildoptions`` (or just ``make``) will take care of updating it.
 
 
 Support scripts