You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2020/09/05 19:51:00 UTC
[GitHub] [incubator-nuttx] adamfeuer opened a new pull request #1722: fix bugs in quickstart docs
adamfeuer opened a new pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722
## Summary
- fix bugs in quickstart docs (see #1720)
- change Gnu to GNU
- fix formatting and link fixes
- add menuconfig screenshot
- replaced config file edits with kconfig-tweak
- fix section numbering
## Impact
- should fix all doc issues listed in #1720
## Testing
- built manually locally
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483985727
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
+the area you're interested in, and leave the rest disabled, and then recompile. You can see the full list of
debug feature areas in the file `debug.h <https://github.com/apache/incubator-nuttx/blob/master/include/debug.h>`__.
-Timestamps can be enabled by setting ``CONFIG_SYSLOG_TIMESTAMP=y``.
+Timestamps can be enabled by enabling ``CONFIG_SYSLOG_TIMESTAMP``:
+
+.. code-block:: console
+
+ $ kconfig-tweak --enable CONFIG_SYSLOG_TIMESTAMP
You may need to do a little bit of experimenting to find the combination of logging settings that work for the problem
you're trying to solve. See the file `debug.h <https://github.com/starcat-io/incubator-nuttx/blob/master/include/debug.h>`_
Review comment:
Did we intend to link to your fork?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483983184
##########
File path: Documentation/quickstart/install.rst
##########
@@ -16,24 +16,23 @@ Install prerequisites for building using Linux
#. Install system packages
- .. code-block:: bash
+ .. code-block:: bash
- $ sudo apt install \
+ $ sudo apt install \
bison flex gettext texinfo libncurses5-dev libncursesw5-dev \
gperf automake libtool pkg-config build-essential gperf \
libgmp-dev libmpc-dev libmpfr-dev libisl-dev binutils-dev libelf-dev \
libexpat-dev gcc-multilib g++-multilib picocom u-boot-tools util-linux
-
#. Give yourself access to the serial console device
This is done by adding your Linux user to the ``dialout`` group:
- .. code-block:: bash
+ .. code-block:: bash
Review comment:
```suggestion
.. code-block:: console
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484003713
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@Ouss4 I didn't find `printf` was enough– I wanted the timestamps that the logging facility produces, so would have had to reinvent that myself if I used `printf` – and `printf` also cannot use the in-memory logging.
While porting the imxrt SDMMC driver to sama5, I found it very helpful to have an independent logging facility that I could use to track timing issues across multiple modules and multiple threads, without unleashing 🙂 a torrent of logging from other modules.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483985985
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
I dont think this will work because there is no Kconfig that defines CUSTOM_INFO. Might be best in the block above to not depend on CONFIG_DEBUG_CUSTOM_INFO and just do the `#define custinfo _info`. Or recommend just using `_info` for debugging.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483989384
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
Review comment:
@btashton If you have a vision for how to rewrite this section, I would love to see that! I would love to learn a better way. I am a NuttX newbie.
I wrote this after being frustrated from a series of long hard driver debugging sessions, from the perspective of someone who knew nothing about NuttX internals and had no guidance about how to learn what was happening inside NuttX. This was my best attempt at telling others information that I wanted to have...
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483989401
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
Review comment:
@btashton The asciinema stuff sounds great too.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687863429
@Ouss4 Ok, I rewrote the debugging section to use the `menuconfig`, and added a screenshot — will you check it out and see what you think? If you have changes or improvements I would love to know them.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483987961
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
Review comment:
I just turn on all the logging levels and then enable logging level for whatever system I need. The only gotcha here is that you need to turn on the global levels first. I also keep that enabled in my defconfig along with things like debug symbols until I am ready to upstream.
My biggest objection is that using things like kconfig-tweak and searching header files is that people do not resolve dependencies correctly or find useful features for what they have enabled. Plus you have docs in menuconfig.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483990757
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@btashton Ok, I added custinfo to debug.h, CUSTOM_INFO to the Kconfig file, and updated docs.
I see what you mean about using the Kconfig menu system to set this– testing it, I can see how it work. Some good instructions would be helpful as an alternative to the kconfig-tweak stuff... but it really needs an asciinema movie to show people what to do... maybe in another PR??
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687903209
Brennan is AFK I believe, btw.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687692835
@v01d I removed the custinfo Kconfig, debug.h, and docs since it seems controversial, maybe I'll submit it in another PR. @btashton was ok with the rest of the fixes.
Would you be willing to merge this?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687903077
LGTM
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483983264
##########
File path: Documentation/quickstart/install.rst
##########
@@ -82,48 +81,48 @@ There are a collection of required tools that need to be built to build most Apa
*NOTE:* You will need to add ``NUTTXTOOLS_PATH`` to your environment ``PATH``
-#. Install kconfig-frontends tool
+#. Install gperf tool
-This is necessary to run the ``./nuttx/tools/configure.sh`` script as well as using the ncurses-based menuconfig system.
+ This required to build ``kconfig-frontends``.
- .. code-block:: bash
+ .. code-block:: bash
Review comment:
```suggestion
.. code-block:: console
```
##########
File path: Documentation/quickstart/install.rst
##########
@@ -82,48 +81,48 @@ There are a collection of required tools that need to be built to build most Apa
*NOTE:* You will need to add ``NUTTXTOOLS_PATH`` to your environment ``PATH``
-#. Install kconfig-frontends tool
+#. Install gperf tool
-This is necessary to run the ``./nuttx/tools/configure.sh`` script as well as using the ncurses-based menuconfig system.
+ This required to build ``kconfig-frontends``.
- .. code-block:: bash
+ .. code-block:: bash
- $ cd tools/
- $ cd kconfig-frontends
- $ # on MacOS do the following:
- $ patch < ../kconfig-macos.diff -p 1
- $ ./configure --prefix=$NUTTXTOOLS --enable-mconf --disable-shared --enable-static --disable-gconf --disable-qconf --disable-nconf
- $ # on Linux do the following:
- $ ./configure --prefix=$NUTTXTOOLS --enable-mconf --disable-gconf --disable-qconf
- $ touch aclocal.m4 Makefile.in
- $ make
- $ make install
+ $ cd tools/
+ $ wget http://ftp.gnu.org/pub/gnu/gperf/gperf-3.1.tar.gz
+ $ tar zxf gperf-3.1.tar.gz
+ $ cd gperf-3.1
+ $ ./configure --prefix=$NUTTXTOOLS
+ $ make
+ $ make install
-#. Install gperf tool
+#. Install kconfig-frontends tool
- This required to build ``kconfig-frontends``.
+ This is necessary to run the ``./nuttx/tools/configure.sh`` script as well as using the ncurses-based menuconfig system.
- .. code-block:: bash
+ .. code-block:: bash
Review comment:
```suggestion
.. code-block:: console
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687656680
There's a leftover todo on quickstart/index.rst
Otherwise this looks LGTM.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] Ouss4 commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
Ouss4 commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484111022
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -49,63 +60,33 @@ Changing Debug Settings Quickly
You can use the ``kconfig-tweak`` script that comes with the ``kconfig-frontends`` tools to quickly change debug settings,
for instance turning them on or off before doing a build:
-.. code-block:: bash
+.. code-block:: console
$ kconfig-tweak --disable CONFIG_DEBUG_NET
+ $ make oldconfig # needed to have the kconfig system check the config
Review comment:
```suggestion
$ make olddefconfig # needed to have the kconfig system check the config
```
Sorry I didn't use the suggestion with this one.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687903652
@Ouss4 I think @btashton is out until Tuesday morning due to a US holiday, but he ok'd everything by the `kconfig-tweak` thing, which I rewrote at your request. He and said not to hold up merging because of him ([see above](https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484008244)). @v01d what do you think?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484010863
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@btashton The issue with solely using `mcinfo` is that I had to look into several other different subsystems – `fs` which uses `fsinfo`, and a couple more that I don't remember right now. With a cross-cutting concern, if you turn on all the logging for several subsytems, that unleashes a torrent of logging. I needed something that I could add to different subsystems without turning everything on.
Anyway, if this is too specialized, I can either go back to having it be a tip in the docs, or remove it completely from the docs and just document it on the wiki or my own website.
Have a great holiday!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483983068
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
.. code-block:: c
Review comment:
```suggestion
.. code-block:: console
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687864089
@Ouss4 In the diff view there is a RST rich diff button available on the upper right in the files view, by the way, that will show the rendered RST (minus screenshot).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] Ouss4 commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
Ouss4 commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687906438
All right, then. Merging.. Thanks @adamfeuer.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] Ouss4 commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
Ouss4 commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687848183
> @Ouss4 Do you want me to rewrite this instruction using the menuconfig system?
I definitely prefer that. What do you all think? Please let know how I can help.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687846049
@Ouss4 Do you want me to rewrite this instruction using the menuconfig system? Or add instructions for menuconfig too? Or...?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] Ouss4 merged pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
Ouss4 merged pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483990844
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@btashton I added a comment in debug.h that says "do not create PRs that include usages of custinfo" – let me know if you want a different message there.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483986325
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
+the area you're interested in, and leave the rest disabled, and then recompile. You can see the full list of
debug feature areas in the file `debug.h <https://github.com/apache/incubator-nuttx/blob/master/include/debug.h>`__.
-Timestamps can be enabled by setting ``CONFIG_SYSLOG_TIMESTAMP=y``.
+Timestamps can be enabled by enabling ``CONFIG_SYSLOG_TIMESTAMP``:
+
+.. code-block:: console
+
+ $ kconfig-tweak --enable CONFIG_SYSLOG_TIMESTAMP
You may need to do a little bit of experimenting to find the combination of logging settings that work for the problem
you're trying to solve. See the file `debug.h <https://github.com/starcat-io/incubator-nuttx/blob/master/include/debug.h>`_
Review comment:
@btashton No, that's an error. Will fix.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] Ouss4 commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
Ouss4 commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483996335
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
Where is this going to be used? If that's something just to track an issue, why not just `printf` that we delete afterwards?
If this is part of a driver, I think using what's available* is readable enough.
*: I mean ainfo for ADC, lcdinfo for LCDs, etc.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483983298
##########
File path: Documentation/quickstart/install.rst
##########
@@ -138,20 +137,20 @@ to use it, modify it or help develop it, you'll need the source code.
You can either clone the public repositories:
- .. code-block:: bash
+.. code-block:: bash
Review comment:
```suggestion
.. code-block:: console
```
##########
File path: Documentation/quickstart/install.rst
##########
@@ -138,20 +137,20 @@ to use it, modify it or help develop it, you'll need the source code.
You can either clone the public repositories:
- .. code-block:: bash
+.. code-block:: bash
- $ mkdir nuttx
- $ cd nuttx
- $ git clone https://github.com/apache/incubator-nuttx.git nuttx
- $ git clone https://github.com/apache/incubator-nuttx-apps apps
+ $ mkdir nuttx
+ $ cd nuttx
+ $ git clone https://github.com/apache/incubator-nuttx.git nuttx
+ $ git clone https://github.com/apache/incubator-nuttx-apps apps
Or, download the `tarball <https://github.com/apache/incubator-nuttx/tarball/master>`_:
- .. code-block:: bash
+.. code-block:: bash
Review comment:
```suggestion
.. code-block:: console
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483989572
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
Review comment:
@adamfeuer Sounds good, we can leave this as is lets just make sure we address the custinfo thing.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483986447
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@btashton using _info for logging produces too much output... How about I add a kconfig entry for CUSTOM_INFO? I could also add the code to debug.h too. That would save people from having to add it.
It's super handy to have a logging statement that you can use for your own purposes that no other module is using.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483986312
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
Review comment:
Is there a reason we are not recommending that people explore the menuconfig? I get that `kconfig-tweak` is useful for turning things on and off, but searching through header files seems to be working against the while point of menuconfig.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483990757
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@btashton Ok, I added custinfo to debug.h, CUSTOM_INFO to the Kconfig file, and updated the docs.
I see what you mean about using the Kconfig menu system to set this– testing it, I can see how it works. It's pretty deep in the menuconfig system. Some good instructions would be helpful as an alternative to the kconfig-tweak stuff... but it really needs an asciinema movie to show people what to do... maybe in another PR??
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484014709
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@Ouss4 @btashton I removed the custinfo Kconfig, debug.h, and docs so that the rest of the error fixes can go in.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687851625
> I definitely prefer that. What do you all think? Please let know how I can help.
Cool. 🙂 I will try now, I'll push changes here– it would be a great help to review them once I get it done.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687849290
Yes, I think it is better. I would consider `kconfig-tweak` use a more "advanced" topic.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] Ouss4 commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
Ouss4 commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484109936
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,38 +6,49 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
-NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
+NuttX has a powerful system logging facility (syslog) with ``info``, ``warn``, and ``error`` levels. You can enable
+debugging for your build for the subsystem or feature by using the ``menuconfig`` system.
- ::
+.. code-block:: console
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
+ $ make menuconfig
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
-debug feature areas in the file `debug.h <https://github.com/apache/incubator-nuttx/blob/master/include/debug.h>`__.
+The debug options are available under ``Build Setup`` > ``Debug Options``. You will most likely have to enable the
+following options:
-Timestamps can be enabled by setting ``CONFIG_SYSLOG_TIMESTAMP=y``.
+* ``Enable Debug Features`` — selecting this will turn on subsystem-level debugging options, they will become visible
+ on the page below. You can then select the ones you want.
+* ``Enable Error Output`` — this will only log errors.
+* ``Enable Warnings Output`` — this will log warnings and errors.
+* ``Enable Informational Debug Output`` — this will produce informational output, warnings, and errors.
+
+You can then select from the subsystems that are available, Network, Scheduler, USB, etc. Note that you will need to
+separately enable the subsystem elsewhere in the ``menuconfig`` system. To see the ``CONFIG`` define that is set,
+use the arrow keys to highlight the subsystem (for instance, ``Network Debug Features``) and type '?'. This will show
+you that the C constant that is set is called ``CONFIG_DEBUG_NET``. ``debug.h`` defines the ``netinfo()`` logging
+function that will log output if this constant is set. You can search the source code for ``netinfo`` to see how it is
Review comment:
```suggestion
function that will log output if this macro is set. You can search the source code for ``netinfo`` to see how it is
```
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,38 +6,49 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
-NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
+NuttX has a powerful system logging facility (syslog) with ``info``, ``warn``, and ``error`` levels. You can enable
+debugging for your build for the subsystem or feature by using the ``menuconfig`` system.
- ::
+.. code-block:: console
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
+ $ make menuconfig
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
-debug feature areas in the file `debug.h <https://github.com/apache/incubator-nuttx/blob/master/include/debug.h>`__.
+The debug options are available under ``Build Setup`` > ``Debug Options``. You will most likely have to enable the
+following options:
-Timestamps can be enabled by setting ``CONFIG_SYSLOG_TIMESTAMP=y``.
+* ``Enable Debug Features`` — selecting this will turn on subsystem-level debugging options, they will become visible
+ on the page below. You can then select the ones you want.
+* ``Enable Error Output`` — this will only log errors.
+* ``Enable Warnings Output`` — this will log warnings and errors.
+* ``Enable Informational Debug Output`` — this will produce informational output, warnings, and errors.
+
+You can then select from the subsystems that are available, Network, Scheduler, USB, etc. Note that you will need to
+separately enable the subsystem elsewhere in the ``menuconfig`` system. To see the ``CONFIG`` define that is set,
+use the arrow keys to highlight the subsystem (for instance, ``Network Debug Features``) and type '?'. This will show
+you that the C constant that is set is called ``CONFIG_DEBUG_NET``. ``debug.h`` defines the ``netinfo()`` logging
Review comment:
```suggestion
you that the C macro that is set is called ``CONFIG_DEBUG_NET``. ``debug.h`` defines the ``netinfo()`` logging
```
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -49,63 +60,33 @@ Changing Debug Settings Quickly
You can use the ``kconfig-tweak`` script that comes with the ``kconfig-frontends`` tools to quickly change debug settings,
for instance turning them on or off before doing a build:
-.. code-block:: bash
+.. code-block:: console
$ kconfig-tweak --disable CONFIG_DEBUG_NET
+ $ make oldconfig # needed to have the kconfig system check the config
Review comment:
I find olddefconfig better as it will without prompting set new symbols to their default value.
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -49,63 +60,33 @@ Changing Debug Settings Quickly
You can use the ``kconfig-tweak`` script that comes with the ``kconfig-frontends`` tools to quickly change debug settings,
for instance turning them on or off before doing a build:
-.. code-block:: bash
+.. code-block:: console
$ kconfig-tweak --disable CONFIG_DEBUG_NET
+ $ make oldconfig # needed to have the kconfig system check the config
$ kconfig-tweak --enable CONFIG_DEBUG_NET
+ $ make oldconfig
Review comment:
```suggestion
$ make olddefconfig
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483986608
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
Review comment:
@btashton Well, when I wrote this, I found using the menuconfig system to turn on and off logging levels to be incredibly frustrating. I found navigating and finding things very difficult. So I resorted to this system.
If you have another way to easily turn on and off logging, or we can refactor the menuconfig system to make this easier, I'm in. Let me know.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483986748
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
I would be open to that with the clear expectation that we would not allow usage of it to be merged in.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687657236
If you don't mind, please squash once you are ready.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484008244
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
I am going AFK for the rest of the holiday, so don't let me hold this up :)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483983371
##########
File path: Documentation/quickstart/install.rst
##########
@@ -168,27 +167,27 @@ binary file on your embedded computer. This guide assumes your computer is an
`script <https://github.com/apache/incubator-nuttx-testing/blob/master/cibuild.sh>`_ and Docker `container <https://github.com/apache/incubator-nuttx-testing/blob/master/docker/linux/Dockerfile>`_
Download the right flavor of the
-`ARM Embedded Gnu Toolchain <https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm>`_
+`ARM Embedded GNU Toolchain <https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm>`_
for your embedded processor's CPU.
Unpack it into ``/opt/gcc`` and add the bin directory to your path. For instance:
- .. code-block:: bash
-
- $ usermod -a -G users $USER
- $ # get a login shell that knows we're in this group:
- $ su - $USER
- $ sudo mkdir /opt/gcc
- $ sudo chgrp -R users /opt/gcc
- $ sudo chmod -R u+rw /opt/gcc
- $ cd /opt/gcc
- $ HOST_PLATFORM=x86_64-linux # use "mac" for macOS.
- $ # For windows there is a zip instead (gcc-arm-none-eabi-9-2019-q4-major-win32.zip)
- $ curl -L -o gcc-arm-none-eabi-9-2019-q4-major-${HOST_PLATFORM}.tar.bz2 https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2019q4/gcc-arm-none-eabi-9-2019-q4-major-${HOST_PLATFORM}.tar.bz2
- $ tar xf gcc-arm-none-eabi-9-2019-q4-major-${HOST_PLATFORM}.tar.bz2
- $ # add the toolchain bin/ dir to your path...
- $ # you can edit your shell's rc files if you don't use bash
- $ echo "export PATH=/opt/gcc/gcc-arm-none-eabi-9-2019-q4-major/bin:$PATH" >> ~/.bashrc
+.. code-block:: bash
Review comment:
```suggestion
.. code-block:: console
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] Ouss4 commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
Ouss4 commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687842857
I have to revive the kconfig-tweek vs menuconfig discussion.
I find debug output the easiest of all CONFIGs_. They are just one after the other. Of course you have to first enable a subsystem before you can see its debug options (CONFIG_NET for CONFIG_DEBUG_NET, CONFIG_CRYPTO for CONFIG_DEBUG_CRYPTO, etc.).
Besides enabling them through kconfig-tweek will just write to the .config file, you'd still have to do `olddefconfig` (or any other config variant including `menuconfig`) to correctly update the .config file.
I don't see that any easier than searching with menuconfig. BTW, one can search in menuconfig with "/".
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484110796
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -49,63 +60,33 @@ Changing Debug Settings Quickly
You can use the ``kconfig-tweak`` script that comes with the ``kconfig-frontends`` tools to quickly change debug settings,
for instance turning them on or off before doing a build:
-.. code-block:: bash
+.. code-block:: console
$ kconfig-tweak --disable CONFIG_DEBUG_NET
+ $ make oldconfig # needed to have the kconfig system check the config
Review comment:
@Ouss4 Cool, thanks. I accepted your suggestions.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r484008158
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@adamfeuer this is where I am also confused because developing that driver I would expect you would have used `mcinfo` which is controlled by `CONFIG_DEBUG_MEMCARD_INFO` and Kconfig describes as "Enable MMC/SD memory card driver informational output to SYSLOG."
example: `arch/arm/src/stm32/stm32_sdio.c`
I guess I would just expect people to use the subsystem logger they are building on or add one if there is not an appropriate.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483988919
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
also if you do add that, the `custinfo` should be defined in the header file
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483983145
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -49,30 +54,30 @@ Changing Debug Settings Quickly
You can use the ``kconfig-tweak`` script that comes with the ``kconfig-frontends`` tools to quickly change debug settings,
for instance turning them on or off before doing a build:
-.. code-block:: bash
+.. code-block:: console
$ kconfig-tweak --disable CONFIG_DEBUG_NET
$ kconfig-tweak --enable CONFIG_DEBUG_NET
You can put a bunch of these into a simple script to configure the logging the way you want:
-.. code-block:: bash
+.. code-block:: console
#!/bin/bash
- $ kconfig-tweak --disable CONFIG_DEBUG_ALERT
- $ kconfig-tweak --disable CONFIG_DEBUG_FEATURES
- $ kconfig-tweak --disable CONFIG_DEBUG_ERROR
- $ kconfig-tweak --disable CONFIG_DEBUG_WARN
- $ kconfig-tweak --disable CONFIG_DEBUG_INFO
- $ kconfig-tweak --disable CONFIG_DEBUG_ASSERTIONS
- $ kconfig-tweak --disable CONFIG_DEBUG_NET
- $ kconfig-tweak --disable CONFIG_DEBUG_NET_ERROR
- $ kconfig-tweak --disable CONFIG_DEBUG_NET_WARN
- $ kconfig-tweak --disable CONFIG_DEBUG_NET_INFO
- $ kconfig-tweak --disable CONFIG_DEBUG_SYMBOLS
- $ kconfig-tweak --disable CONFIG_DEBUG_NOOPT
- $ kconfig-tweak --disable CONFIG_SYSLOG_TIMESTAMP
+ kconfig-tweak --disable CONFIG_DEBUG_ALERT
Review comment:
I think for `console` you need the prompt. Otherwise it is assumed to be output of a command and it appears dimmer.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483983781
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -49,30 +54,30 @@ Changing Debug Settings Quickly
You can use the ``kconfig-tweak`` script that comes with the ``kconfig-frontends`` tools to quickly change debug settings,
for instance turning them on or off before doing a build:
-.. code-block:: bash
+.. code-block:: console
$ kconfig-tweak --disable CONFIG_DEBUG_NET
$ kconfig-tweak --enable CONFIG_DEBUG_NET
You can put a bunch of these into a simple script to configure the logging the way you want:
-.. code-block:: bash
+.. code-block:: console
#!/bin/bash
- $ kconfig-tweak --disable CONFIG_DEBUG_ALERT
- $ kconfig-tweak --disable CONFIG_DEBUG_FEATURES
- $ kconfig-tweak --disable CONFIG_DEBUG_ERROR
- $ kconfig-tweak --disable CONFIG_DEBUG_WARN
- $ kconfig-tweak --disable CONFIG_DEBUG_INFO
- $ kconfig-tweak --disable CONFIG_DEBUG_ASSERTIONS
- $ kconfig-tweak --disable CONFIG_DEBUG_NET
- $ kconfig-tweak --disable CONFIG_DEBUG_NET_ERROR
- $ kconfig-tweak --disable CONFIG_DEBUG_NET_WARN
- $ kconfig-tweak --disable CONFIG_DEBUG_NET_INFO
- $ kconfig-tweak --disable CONFIG_DEBUG_SYMBOLS
- $ kconfig-tweak --disable CONFIG_DEBUG_NOOPT
- $ kconfig-tweak --disable CONFIG_SYSLOG_TIMESTAMP
+ kconfig-tweak --disable CONFIG_DEBUG_ALERT
Review comment:
@v01d Ok, thanks for catching. I accepted your changes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687657573
@v01d Thanks for catching all those issues. I rebased and squashed and force-pushed. If @btashton is good with the fixes, it should be good to merge.
BTW we should add interactive rebase to the docs to show how to squash the commits. 🙂
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483990757
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -93,11 +98,11 @@ You can add your own custom debug logging by adding the following lines to
# define custinfo _none
#endif
-You need to add the following line to your ``.config`` file:
+You need to enable the setting this way:
-.. code-block:: c
+.. code-block:: console
- CONFIG_DEBUG_CUSTOM_INFO=y
+ $ kconfig-tweak --enable CONFIG_CUSTOM_INFO
Review comment:
@btashton Ok, I added custinfo to debug.h, CUSTOM_INFO to the Kconfig file, and updated the docs.
I see what you mean about using the Kconfig menu system to set this– testing it, I can see how it work. Some good instructions would be helpful as an alternative to the kconfig-tweak stuff... but it really needs an asciinema movie to show people what to do... maybe in another PR??
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer edited a comment on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer edited a comment on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687657573
@v01d Thanks for catching all those issues. I rebased and squashed and force-pushed. If @btashton is ok with the fixes, it should be good to merge.
BTW we should add interactive rebase to the docs to show how to squash the commits. 🙂
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] adamfeuer commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
adamfeuer commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687896795
@Ouss4 Thanks for catching that! Ok, rebased, squashed, force-pushed, should be good to go. Do you have other improvements or comments?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
btashton commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483988388
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -6,35 +6,40 @@ Debugging
Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
-debugging using the Gnu Debugger (gdb).
+debugging using the GNU Debugger (gdb).
Debug Logging
-------------
NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
-build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
-
- ::
-
- CONFIG_DEBUG_ALERT=y
- CONFIG_DEBUG_FEATURES=y
- CONFIG_DEBUG_ERROR=y
- CONFIG_DEBUG_WARN=y
- CONFIG_DEBUG_INFO=y
- CONFIG_DEBUG_ASSERTIONS=y
- CONFIG_DEBUG_NET=y
- CONFIG_DEBUG_NET_ERROR=y
- CONFIG_DEBUG_NET_WARN=y
- CONFIG_DEBUG_NET_INFO=y
- CONFIG_DEBUG_SYMBOLS=y
- CONFIG_DEBUG_NOOPT=y
- CONFIG_SYSLOG_TIMESTAMP=y
-
-Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
-the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+build for the ``net`` feature (TCP/IP stack) by running this simple script:
+
+.. code-block:: console
+
+ #!/bin/bash
+
+ kconfig-tweak --enable CONFIG_DEBUG_ALERT
+ kconfig-tweak --enable CONFIG_DEBUG_FEATURES
+ kconfig-tweak --enable CONFIG_DEBUG_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_ASSERTIONS
+ kconfig-tweak --enable CONFIG_DEBUG_NET
+ kconfig-tweak --enable CONFIG_DEBUG_NET_ERROR
+ kconfig-tweak --enable CONFIG_DEBUG_NET_WARN
+ kconfig-tweak --enable CONFIG_DEBUG_NET_INFO
+ kconfig-tweak --enable CONFIG_DEBUG_SYMBOLS
+ kconfig-tweak --enable CONFIG_DEBUG_NOOPT
+
+Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
Review comment:
I also would like to add some https://asciinema.org/ demos which we can embed in the docs, but that is for later.
https://pypi.org/project/sphinxcontrib.asciinema/
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#discussion_r483983287
##########
File path: Documentation/quickstart/install.rst
##########
@@ -82,48 +81,48 @@ There are a collection of required tools that need to be built to build most Apa
*NOTE:* You will need to add ``NUTTXTOOLS_PATH`` to your environment ``PATH``
-#. Install kconfig-frontends tool
+#. Install gperf tool
-This is necessary to run the ``./nuttx/tools/configure.sh`` script as well as using the ncurses-based menuconfig system.
+ This required to build ``kconfig-frontends``.
- .. code-block:: bash
+ .. code-block:: bash
- $ cd tools/
- $ cd kconfig-frontends
- $ # on MacOS do the following:
- $ patch < ../kconfig-macos.diff -p 1
- $ ./configure --prefix=$NUTTXTOOLS --enable-mconf --disable-shared --enable-static --disable-gconf --disable-qconf --disable-nconf
- $ # on Linux do the following:
- $ ./configure --prefix=$NUTTXTOOLS --enable-mconf --disable-gconf --disable-qconf
- $ touch aclocal.m4 Makefile.in
- $ make
- $ make install
+ $ cd tools/
+ $ wget http://ftp.gnu.org/pub/gnu/gperf/gperf-3.1.tar.gz
+ $ tar zxf gperf-3.1.tar.gz
+ $ cd gperf-3.1
+ $ ./configure --prefix=$NUTTXTOOLS
+ $ make
+ $ make install
-#. Install gperf tool
+#. Install kconfig-frontends tool
- This required to build ``kconfig-frontends``.
+ This is necessary to run the ``./nuttx/tools/configure.sh`` script as well as using the ncurses-based menuconfig system.
- .. code-block:: bash
+ .. code-block:: bash
- $ cd tools/
- $ wget http://ftp.gnu.org/pub/gnu/gperf/gperf-3.1.tar.gz
- $ tar zxf gperf-3.1.tar.gz
- $ cd gperf-3.1
- $ ./configure --prefix=$NUTTXTOOLS
- $ make
- $ make install
+ $ cd tools/
+ $ cd kconfig-frontends
+ $ # on MacOS do the following:
+ $ patch < ../kconfig-macos.diff -p 1
+ $ ./configure --prefix=$NUTTXTOOLS --enable-mconf --disable-shared --enable-static --disable-gconf --disable-qconf --disable-nconf
+ $ # on Linux do the following:
+ $ ./configure --prefix=$NUTTXTOOLS --enable-mconf --disable-gconf --disable-qconf
+ $ touch aclocal.m4 Makefile.in
+ $ make
+ $ make install
#. Install gen-romfs (optional)
This is required if you want to build ROM-based file systems.
- .. code-block:: bash
+ .. code-block:: bash
Review comment:
```suggestion
.. code-block:: console
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] Ouss4 commented on pull request #1722: fix bugs in quickstart docs
Posted by GitBox <gi...@apache.org>.
Ouss4 commented on pull request #1722:
URL: https://github.com/apache/incubator-nuttx/pull/1722#issuecomment-687900697
Thanks Adam, LGTM. If @v01d or @btashton have no comments, we can merge this.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org