From 541b26f0fffa688959f47e150cce0daa87bfa3bb Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Wed, 24 Dec 2014 08:15:21 -0600 Subject: [PATCH] Cosmet updates to comments and README files --- README.txt | 54 +++++++++++++++++++ configs/dk-tm4c129x/README.txt | 8 +-- configs/dk-tm4c129x/src/dk-tm4c129x.h | 4 +- configs/dk-tm4c129x/src/tm4c_boot.c | 4 +- configs/dk-tm4c129x/src/tm4c_ssi.c | 6 +-- configs/sama5d4-ek/include/board_sdram.h | 2 +- configs/sama5d4-ek/src/sam_adc.c | 3 +- configs/sama5d4-ek/src/sam_buttons.c | 2 +- configs/sama5d4-ek/src/sam_cxxinitialize.c | 2 +- configs/sama5d4-ek/src/sam_ostest.c | 2 +- configs/sama5d4-ek/src/sam_pwm.c | 2 +- configs/sama5d4-ek/src/sam_spi.c | 2 +- configs/sama5d4-ek/src/sam_userleds.c | 2 +- configs/tm4c123g-launchpad/include/board.h | 2 +- .../src/tm4c123g-launchpad.h | 2 +- .../tm4c123g-launchpad/src/tm4c_autoleds.c | 2 +- configs/tm4c123g-launchpad/src/tm4c_boot.c | 2 +- configs/tm4c123g-launchpad/src/tm4c_ssi.c | 2 +- 18 files changed, 78 insertions(+), 25 deletions(-) diff --git a/README.txt b/README.txt index d10f8f6bb0..763738aecb 100644 --- a/README.txt +++ b/README.txt @@ -12,6 +12,8 @@ README - Instantiating "Canned" Configurations - Refreshing Configurations - NuttX Configuration Tool + - Finding Selections in the Configuration Menus + - Comparing Two Configurations - Incompatibilities with Older Configurations - NuttX Configuration Tool under DOS o Toolchains @@ -401,6 +403,58 @@ NuttX Configuration Tool make gconfig +Finding Selections in the Configuration Menus +--------------------------------------------- + + The NuttX configuration options have gotten complex and it can be very + difficult to find options in the menu trees if you are not sure where + to look. The "basic configuration order" describe above can help to + narrow things down. + + But if you know exactly what configuration setting you want to select, + say CONFIG_XYZ, but not where to find it, then the 'make memconfig' + version of the tool offers some help: By pressing the '/' key, the + tool will bring up a menu that will allow you to search for a + configuration item. Just enter the string CONFIG_XYZ and press 'ENTER'. + It will show you not only where to find the configuration item, but + also all of the dependencies related to the configuration item. + +Comparing Two Configurations +---------------------------- + + If you try to compare to configurations using 'diff', you will probably + not be happy with the result. There are superfluous things added to + the configuration files that makes comparisons with the human eye + difficult. + + There is a tool at nuttx/tools/cmpconfig.c that can be build to simplify + these comparisons. The output from this difference tools will show only + the meaningful differences between two configuration files. This tools + built as follows: + + cd nuttx/tools + make -f Makefile.host + + This will crate a program called 'cmpconfig' or 'comconfig.exe' on Windows. + + Why would you want to compare two configuration files? Here are a couple + of reasons why I do this: + + 1. When I create a new configuration I usually base it on an older + configuration and I want to know, "What are the options that I need to + change to add the new feature to the older configurations?" For example, + suppose that I have a boardA/nsh configuration and I want to crate a + boardA/nxwm configuration. Suppose I already have boardB/nsh and + boardB/nxwm configurations. Then by comparing the boardB/nsh with the + boardB/nxwm I can see the modifications that I would need to make to my + boardA/nsh to create a new boardA/nxwm. + + 2. But the most common reason that I use the 'cmpconfig' program to to + check the results of "refreshing" a configuration with 'make oldconfig' + (see the next paragraph). The 'make oldconfig' command will make + changes to my configuration and using 'cmpconfig', I can see precisely + what those changes were and if any should be of concern to me. + Refreshing Configurations with 'make oldconfig' ----------------------------------------------- diff --git a/configs/dk-tm4c129x/README.txt b/configs/dk-tm4c129x/README.txt index 381f914bab..93e9c77b86 100644 --- a/configs/dk-tm4c129x/README.txt +++ b/configs/dk-tm4c129x/README.txt @@ -2,11 +2,11 @@ README.txt ========== This README file discuss discusses the port of NuttX to the Texas - Instruments DK-TM4C129x Connected Development Kit. + Instruments DK-TM4C129X Connected Development Kit. Description ----------- - The Tiva™ C Series TM4C129x Connected Development Kit highlights + The Tiva™ C Series TM4C129X Connected Development Kit highlights the 120-MHz Tiva C Series TM4C129XNCZAD ARM® Cortex™-M4 based microcontroller, including an integrated 10/100 Ethernet MAC + PHY as well as many other key features. @@ -461,13 +461,13 @@ DK-TM4129X Configuration Options There are configurations for disabling support for interrupts GPIO ports. Only GPIOP and GPIOQ pins can be used as interrupting sources on the - TM4C129x. Additional interrupt support can be disabled if desired to + TM4C129X. Additional interrupt support can be disabled if desired to reduce memory footprint. CONFIG_TIVA_GPIOP_IRQS=y CONFIG_TIVA_GPIOQ_IRQS=y - TM4C129x specific device driver settings + TM4C129X specific device driver settings CONFIG_UARTn_SERIAL_CONSOLE - selects the UARTn for the console and ttys0 (default is the UART0). diff --git a/configs/dk-tm4c129x/src/dk-tm4c129x.h b/configs/dk-tm4c129x/src/dk-tm4c129x.h index 543a1dbeac..7a8b7f6d8a 100644 --- a/configs/dk-tm4c129x/src/dk-tm4c129x.h +++ b/configs/dk-tm4c129x/src/dk-tm4c129x.h @@ -47,7 +47,7 @@ #include "tiva_gpio.h" /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* Configuration ********************************************************************/ @@ -110,7 +110,7 @@ * Name: tm4c_ssiinitialize * * Description: - * Called to configure SPI chip select GPIO pins for the DK-TM4C129x. + * Called to configure SPI chip select GPIO pins for the DK-TM4C129X. * ************************************************************************************/ diff --git a/configs/dk-tm4c129x/src/tm4c_boot.c b/configs/dk-tm4c129x/src/tm4c_boot.c index b35cc325b8..0da8dcc8d9 100644 --- a/configs/dk-tm4c129x/src/tm4c_boot.c +++ b/configs/dk-tm4c129x/src/tm4c_boot.c @@ -48,7 +48,7 @@ #include "dk-tm4c129x.h" /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /************************************************************************************ @@ -75,7 +75,7 @@ void tiva_boardinitialize(void) * tm4c_ssiinitialize() has been brought into the link. */ - /* The DK-TM4C129x microSD CS and OLED are on SSI0 */ + /* The DK-TM4C129X microSD CS and OLED are on SSI0 */ #if defined(CONFIG_TIVA_SSI0) || defined(CONFIG_TIVA_SSI1) if (tm4c_ssiinitialize) diff --git a/configs/dk-tm4c129x/src/tm4c_ssi.c b/configs/dk-tm4c129x/src/tm4c_ssi.c index 2d021d902b..60d36af24e 100644 --- a/configs/dk-tm4c129x/src/tm4c_ssi.c +++ b/configs/dk-tm4c129x/src/tm4c_ssi.c @@ -51,12 +51,12 @@ #include "tiva_gpio.h" #include "dk-tm4c129x.h" -/* The DK-TM4C129x microSD CS is on SSI0 */ +/* The DK-TM4C129X microSD CS is on SSI0 */ #if defined(CONFIG_TIVA_SSI0) || defined(CONFIG_TIVA_SSI1) /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* CONFIG_DEBUG_SPI enables debug output from this file (needs CONFIG_DEBUG too) */ @@ -89,7 +89,7 @@ * Name: tm4c_ssiinitialize * * Description: - * Called to configure SPI chip select GPIO pins for the DK-TM4C129x. + * Called to configure SPI chip select GPIO pins for the DK-TM4C129X. * ************************************************************************************/ diff --git a/configs/sama5d4-ek/include/board_sdram.h b/configs/sama5d4-ek/include/board_sdram.h index 8870475ec2..288e6a87d5 100644 --- a/configs/sama5d4-ek/include/board_sdram.h +++ b/configs/sama5d4-ek/include/board_sdram.h @@ -44,7 +44,7 @@ #include "sam_pmc.h" /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* Clocking *************************************************************************/ diff --git a/configs/sama5d4-ek/src/sam_adc.c b/configs/sama5d4-ek/src/sam_adc.c index 31f4d7c94e..f45cc47995 100644 --- a/configs/sama5d4-ek/src/sam_adc.c +++ b/configs/sama5d4-ek/src/sam_adc.c @@ -50,9 +50,8 @@ #ifdef CONFIG_ADC /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ -/* Configuration ********************************************************************/ /************************************************************************************ * Private Data diff --git a/configs/sama5d4-ek/src/sam_buttons.c b/configs/sama5d4-ek/src/sam_buttons.c index 2df0c8fbe6..082a31965d 100644 --- a/configs/sama5d4-ek/src/sam_buttons.c +++ b/configs/sama5d4-ek/src/sam_buttons.c @@ -64,7 +64,7 @@ #ifdef CONFIG_ARCH_BUTTONS /**************************************************************************** - * Definitions + * Pre-processor Definitions ****************************************************************************/ /**************************************************************************** diff --git a/configs/sama5d4-ek/src/sam_cxxinitialize.c b/configs/sama5d4-ek/src/sam_cxxinitialize.c index 28f3cb2f6a..1972c68485 100644 --- a/configs/sama5d4-ek/src/sam_cxxinitialize.c +++ b/configs/sama5d4-ek/src/sam_cxxinitialize.c @@ -49,7 +49,7 @@ #if defined(CONFIG_HAVE_CXX) && defined(CONFIG_HAVE_CXXINITIALIZE) /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* Debug ****************************************************************************/ /* Non-standard debug that may be enabled just for testing the static constructors */ diff --git a/configs/sama5d4-ek/src/sam_ostest.c b/configs/sama5d4-ek/src/sam_ostest.c index 7b1ad28fbb..96bdb26dc7 100644 --- a/configs/sama5d4-ek/src/sam_ostest.c +++ b/configs/sama5d4-ek/src/sam_ostest.c @@ -52,7 +52,7 @@ #include "sama5d4-ek.h" /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* Configuration ********************************************************************/ diff --git a/configs/sama5d4-ek/src/sam_pwm.c b/configs/sama5d4-ek/src/sam_pwm.c index 7f01328b01..f6a5cb4074 100644 --- a/configs/sama5d4-ek/src/sam_pwm.c +++ b/configs/sama5d4-ek/src/sam_pwm.c @@ -50,7 +50,7 @@ #include "sama5d4-ek.h" /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* Configuration ********************************************************************/ /* PWM. There are no dedicated PWM output pins available to the user for PWM diff --git a/configs/sama5d4-ek/src/sam_spi.c b/configs/sama5d4-ek/src/sam_spi.c index 56105cfbc2..b04a6f7e47 100644 --- a/configs/sama5d4-ek/src/sam_spi.c +++ b/configs/sama5d4-ek/src/sam_spi.c @@ -56,7 +56,7 @@ #if defined(CONFIG_SAMA5_SPI0) || defined(CONFIG_SAMA5_SPI1) /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* Enables debug output from this file (needs CONFIG_DEBUG too) */ diff --git a/configs/sama5d4-ek/src/sam_userleds.c b/configs/sama5d4-ek/src/sam_userleds.c index bc8ce1d5de..6c95ae87a6 100644 --- a/configs/sama5d4-ek/src/sam_userleds.c +++ b/configs/sama5d4-ek/src/sam_userleds.c @@ -68,7 +68,7 @@ #ifndef CONFIG_ARCH_LEDS /**************************************************************************** - * Definitions + * Pre-processor Definitions ****************************************************************************/ /* CONFIG_DEBUG_LEDS enables debug output from this file (needs CONFIG_DEBUG diff --git a/configs/tm4c123g-launchpad/include/board.h b/configs/tm4c123g-launchpad/include/board.h index f2ebca3f40..dc8029a9f0 100644 --- a/configs/tm4c123g-launchpad/include/board.h +++ b/configs/tm4c123g-launchpad/include/board.h @@ -41,7 +41,7 @@ ************************************************************************************/ /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* Clocking *************************************************************************/ diff --git a/configs/tm4c123g-launchpad/src/tm4c123g-launchpad.h b/configs/tm4c123g-launchpad/src/tm4c123g-launchpad.h index 90048154f2..05c5ea6b28 100644 --- a/configs/tm4c123g-launchpad/src/tm4c123g-launchpad.h +++ b/configs/tm4c123g-launchpad/src/tm4c123g-launchpad.h @@ -47,7 +47,7 @@ #include "tiva_gpio.h" /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* Configuration ********************************************************************/ diff --git a/configs/tm4c123g-launchpad/src/tm4c_autoleds.c b/configs/tm4c123g-launchpad/src/tm4c_autoleds.c index 7646898b16..fa8d3d8265 100644 --- a/configs/tm4c123g-launchpad/src/tm4c_autoleds.c +++ b/configs/tm4c123g-launchpad/src/tm4c_autoleds.c @@ -51,7 +51,7 @@ #include "tm4c123g-launchpad.h" /**************************************************************************** - * Definitions + * Pre-processor Definitions ****************************************************************************/ /* The TM4C123G LaunchPad has a single RGB LED. There is only one visible LED * which will vary in color. But, from the standpoint of the firmware, this diff --git a/configs/tm4c123g-launchpad/src/tm4c_boot.c b/configs/tm4c123g-launchpad/src/tm4c_boot.c index 7ad94d973d..d76dddab7c 100644 --- a/configs/tm4c123g-launchpad/src/tm4c_boot.c +++ b/configs/tm4c123g-launchpad/src/tm4c_boot.c @@ -48,7 +48,7 @@ #include "tm4c123g-launchpad.h" /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /************************************************************************************ diff --git a/configs/tm4c123g-launchpad/src/tm4c_ssi.c b/configs/tm4c123g-launchpad/src/tm4c_ssi.c index dd94d97bb0..eedae3e771 100644 --- a/configs/tm4c123g-launchpad/src/tm4c_ssi.c +++ b/configs/tm4c123g-launchpad/src/tm4c_ssi.c @@ -56,7 +56,7 @@ #if defined(CONFIG_TIVA_SSI0) || defined(CONFIG_TIVA_SSI1) /************************************************************************************ - * Definitions + * Pre-processor Definitions ************************************************************************************/ /* CONFIG_DEBUG_SPI enables debug output from this file (needs CONFIG_DEBUG too) */