[PATCH] rsb: replace asciidoc with rst formatting

Gedare Bloom gedare at rtems.org
Sun Apr 5 21:06:01 UTC 2020


I pushed all my pending docs patches

On Sun, Apr 5, 2020 at 2:48 PM Gedare Bloom <gedare at rtems.org> wrote:
>
> ---
>  user/rsb/commands.rst      | 10 +++++-----
>  user/rsb/configuration.rst | 10 +++++-----
>  2 files changed, 10 insertions(+), 10 deletions(-)
>
> diff --git a/user/rsb/commands.rst b/user/rsb/commands.rst
> index b85692d..b4787aa 100644
> --- a/user/rsb/commands.rst
> +++ b/user/rsb/commands.rst
> @@ -199,22 +199,22 @@ The ``arguments`` are a list of build sets to build.
>    Path to the configuration directory. This overrides the built in defaults.
>
>  ``--builddir path``:
> -  Path to the build directory. This overrides the default of +build+.
> +  Path to the build directory. This overrides the default of `build`.
>
>  ``--sourcedir path``:
> -  Path to the source directory. This overrides the default of +source+.
> +  Path to the source directory. This overrides the default of `source`.
>
>  ``--patchdir path``:
> -  Path to the patches directory. This overrides the default of +patches+.
> +  Path to the patches directory. This overrides the default of `patches`.
>
>  ``--tmppath path``:
> -  Path to the temporary directory. This overrides the default of +tmp+.
> +  Path to the temporary directory. This overrides the default of `tmp`.
>
>  ``--macros files``:
>    Macro files to load. The configuration directory path is searched.
>
>  ``--log file``:
> -  Log all the output from the build process. The output is directed to +stdout+
> +  Log all the output from the build process. The output is directed to `stdout`
>    if no log file is provided.
>
>  ``--url url``:
> diff --git a/user/rsb/configuration.rst b/user/rsb/configuration.rst
> index 541b3fd..8d0ac14 100644
> --- a/user/rsb/configuration.rst
> +++ b/user/rsb/configuration.rst
> @@ -972,10 +972,10 @@ expansions supported are:
>  %prep
>  ~~~~~
>
> -The +%prep+ macro starts a block that continues until the next block macro. The
> +The `%prep` macro starts a block that continues until the next block macro. The
>  *prep* or preparation block defines the setup of the package's source and is a
>  mix of RTEMS Source Builder macros and shell scripting. The sequence is
> -typically +%source+ macros for source, +%patch+ macros to patch the source
> +typically `%source` macros for source, `%patch` macros to patch the source
>  mixed with some shell commands to correct any source issues:
>
>  .. code-block:: spec
> @@ -999,7 +999,7 @@ example:
>
>  This URL is the primary location of the GNU GDB source code and the RTEMS
>  Source Builder can download the file from this location and by inspecting the
> -file extension use ``bzip2`` decompression with +tar+. When the ``%prep``
> +file extension use ``bzip2`` decompression with `tar`. When the ``%prep``
>  section is processed a check of the local ``source`` directory is made to see
>  if the file has already been downloaded. If not found in the source cache
>  directory the package is downloaded from the URL. You can append other base
> @@ -1040,9 +1040,9 @@ and set up with:
>
>  Patching also occurs during the preparation stage. Patches are handled in a
>  similar way to the source packages except you only ``add`` patches. Patches are
> -applied using the +setup+ command. The +setup+ command takes the default patch
> +applied using the `setup` command. The `setup` command takes the default patch
>  option. You can provide options with each patch by adding them as arguments
> -before the patch URL. Patches with no options uses the +setup+ default.
> +before the patch URL. Patches with no options uses the `setup` default.
>
>  .. code-block:: spec
>
> --
> 2.17.1
>


More information about the devel mailing list