Dear all,
I have made a small patch to improve the documentation of the quickstart
guide. Please have a look and let me know what you think.
P.S.: This is my first patch so feel free to let me know if I made any
mistakes.
Regards,
Utkarsh
From 1377d30f47b22133f8514d2525d6390573e181ca Mon Sep 17 00:00:00 2001
From: Utkarsh Verma <utka...@bitbanged.com>
Date: Thu, 23 Mar 2023 09:13:09 +0530
Subject: [PATCH 0/1] *** Improve coherence of user/start docs ***
This patch improves consistency of the documentation in the user/start
section. In app.rst, absolute path has been removed because the PATH had
already been set appropriately in the previous page, i.e. bsp-buil. In
bsp-build.rst, instructions have been removed for manually creating a
build directory as it is unnecessary. Apart from that, minor grammatical
fixes have been made.
Utkarsh Verma (1):
bsp-howto: Fix grammar and improve coherence.
user/start/app.rst | 2 +-
user/start/bsp-build.rst | 17 +++++------------
2 files changed, 6 insertions(+), 13 deletions(-)
--
2.40.0
From 1377d30f47b22133f8514d2525d6390573e181ca Mon Sep 17 00:00:00 2001
From: Utkarsh Verma <utka...@bitbanged.com>
Date: Thu, 23 Mar 2023 09:10:47 +0530
Subject: [PATCH 1/1] bsp-howto: Fix grammar and improve coherence.
---
user/start/app.rst | 2 +-
user/start/bsp-build.rst | 17 +++++------------
2 files changed, 6 insertions(+), 13 deletions(-)
diff --git a/user/start/app.rst b/user/start/app.rst
index ce9a44d..0599305 100644
--- a/user/start/app.rst
+++ b/user/start/app.rst
@@ -209,7 +209,7 @@ Run the executable:
.. code-block:: none
- $HOME/quick-start/rtems/@rtems-ver-major@/bin/rtems-run --rtems-bsps=erc32-sis build/sparc-rtems@rtems-ver-major@-erc32/hello.exe
+ rtems-run --rtems-bsps=erc32-sis build/sparc-rtems@rtems-ver-major@-erc32/hello.exe
The output will be something close to:
diff --git a/user/start/bsp-build.rst b/user/start/bsp-build.rst
index 8401d71..585d009 100644
--- a/user/start/bsp-build.rst
+++ b/user/start/bsp-build.rst
@@ -99,16 +99,9 @@ If you have built a BSP with the RSB, you can move on to
Manual BSP Build
----------------
-We manually build the BSP in four steps. The first step is to create a build
-directory. It must be separate from the RTEMS source directory. We use
-:file:`$HOME/quick-start/build/b-erc32`.
-
-.. code-block:: none
-
- mkdir -p $HOME/quick-start/build/b-erc32
-
-The second step is to set your path. Prepend the RTEMS tool suite binary
-directory to your ``$PATH`` throughout the remaining steps. Run the command:
+We manually build the BSP in four steps. The first step is to set your path.
+Prepend the RTEMS tool suite binary directory to your ``$PATH`` throughout the
+remaining steps. Run the command:
.. code-block:: none
@@ -133,7 +126,7 @@ has not been correctly set. Check the contents of the path
file cannot be found return to :ref:`QuickStartTools` and install the tools
again.
-The first step is to configure the BSP. There are various BSP build
+The second step is to configure the BSP. There are various BSP build
configuration options available. Some options are BSP-specific. Each section
in the INI-style configuration file ``config.ini`` instructs the build system to
build a particular BSP variant (`sparc/erc32` in our case). We enable the build
@@ -179,7 +172,7 @@ by ``$BASE``.
Checking for program 'xz' : $BASE/anaconda3/bin/xz
'configure' finished successfully (0.414s)
-Building the BSP is the second step.
+Building the BSP is the third step.
.. code-block:: none
--
2.40.0
_______________________________________________
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel
