You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by ar...@apache.org on 2024/02/15 09:48:35 UTC

(nuttx) branch master updated: fix typo error in quickstart compiling_cmake

This is an automated email from the ASF dual-hosted git repository.

archer pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git


The following commit(s) were added to refs/heads/master by this push:
     new 410ac71b70 fix typo error in quickstart compiling_cmake
410ac71b70 is described below

commit 410ac71b701e0ff1fb97147a17593f38b13f0139
Author: KMSorSMS <yz...@126.com>
AuthorDate: Wed Feb 14 21:03:45 2024 +0800

    fix typo error in quickstart compiling_cmake
    
    "
    I used
    
    cd nuttx
    cmake -B build -DBOARD_CONFIG=stm32f401rc-rs485:nsh -GNinja
    
    to config
    and when following the instruction in this official websites I found the
    command to use cmake to build the target is wrong.
    which is "cmake --build build -t menuconfig" also wrong the output dir
    "build/nuttx".
    and by the way, In my practice I find the bin file and elf file is not
    in build/nuttx but in build/. So I changed these. But I'm not 100% sure
    that my fix is right as I'm a beginner, but what I fix works fine in my
    computer. This is my first PR to the public doc. My fix maybe totally
    wrong as I am not get into the nuttx, just following the instruction and
    encountered some mistakes.
    thx for reviewing
    "
---
 Documentation/quickstart/compiling_cmake.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/quickstart/compiling_cmake.rst b/Documentation/quickstart/compiling_cmake.rst
index 6a4df5aadf..86259aa6b1 100644
--- a/Documentation/quickstart/compiling_cmake.rst
+++ b/Documentation/quickstart/compiling_cmake.rst
@@ -45,10 +45,10 @@ We can now build NuttX. To do so, you can simply run:
   .. code-block:: console
 
      $ cd nuttx
-     $ cmake --build build -t menuconfig 
+     $ cmake --build build 
 
 The build will complete by generating the binary outputs
-inside ``build/nuttx`` directory. Typically this includes the ``nuttx``
+inside ``build/`` directory. Typically this includes the ``nuttx``
 ELF file (suitable for debugging using ``gdb``) and a ``nuttx.bin``
 file that can be flashed to the board.