Documentation: remove readme references
This commit is contained in:
raiden00pl
Alan Carvalho de Assis
parent
d72c6802c1
commit
770df6d820
@ -3,8 +3,7 @@
|
||||
=================================
|
||||
|
||||
This directory contains a small program that will mount a ROMFS file system
|
||||
containing the BASIC test files extracted from the Bas ``2.4`` release. See
|
||||
``examples/bastest/README.md`` for licensing and usage information.
|
||||
containing the BASIC test files extracted from the Bas ``2.4`` release.
|
||||
|
||||
- ``CONFIG_EXAMPLES_BASTEST_DEVMINOR`` – The minor device number of the ROMFS
|
||||
block driver. For example, the ``N`` in ``/dev/ramN``. Used for registering the
|
||||
|
||||
@ -14,7 +14,7 @@ valid images.
|
||||
|
||||
This application add 3 Builtin Apps to NuttX NSH: version, set_img and confirm.
|
||||
After application is build and ``nuttx.bin`` be generated, the binary must be
|
||||
signed. Consult your board README file to get instructions how to do it.
|
||||
signed. Consult your board documentation page to get instructions how to do it.
|
||||
|
||||
How to build and flash
|
||||
......................
|
||||
@ -33,7 +33,8 @@ as output file.
|
||||
The ``signedv1.bin`` file must be at MCUboot Slot-0 partition and ``signedv2.bin``
|
||||
at Slot-1.
|
||||
|
||||
More instructions about how to sign and flash can be found at board README file.
|
||||
More instructions about how to sign and flash can be found at board documentation
|
||||
page.
|
||||
|
||||
Running swap image test
|
||||
.......................
|
||||
|
||||
@ -15,5 +15,6 @@ http://developer.berlios.de/project/showfiles.php?group_id=6120.
|
||||
- ``CONFIG_EXAMPLES_MODBUS_REG_HOLDING_START``, Default ``2000``.
|
||||
- ``CONFIG_EXAMPLES_MODBUS_REG_HOLDING_NREGS``, Default ``130``.
|
||||
|
||||
The FreeModBus library resides at ``apps/modbus``. See ``apps/modbus/README.txt``
|
||||
for additional configuration information.
|
||||
The FreeModBus library resides at ``apps/modbus``.
|
||||
See :doc:`/applications/industry/modbus/index` for additional configuration
|
||||
information.
|
||||
|
||||
@ -14,8 +14,8 @@ specific PWM settings might require additional settings).
|
||||
Default: Built as a standalone program.
|
||||
|
||||
Additional configuration options will mostly likely be required for the board-
|
||||
specific lower-half driver. See the ``README.txt`` file in your board
|
||||
configuration directory.
|
||||
specific lower-half driver. See the documentation page for your board.
|
||||
|
||||
|
||||
Specific configuration options for this example include:
|
||||
|
||||
|
||||
@ -3,8 +3,7 @@
|
||||
========================
|
||||
|
||||
An example that builds ``netutils/thttpd`` with some simple NXFLAT CGI programs.
|
||||
See ``boards/README.txt`` for most THTTPD settings. In addition to those, this
|
||||
example accepts:
|
||||
In addition to those, this example accepts:
|
||||
|
||||
- ``CONFIG_EXAMPLES_THTTPD_NOMAC`` – (May be defined to use software assigned
|
||||
MAC)
|
||||
|
||||
@ -25,5 +25,5 @@ Configuration options. Use the defaults if you are unsure of what you are doing:
|
||||
number.
|
||||
- ``CONFIG_EXAMPLES_UNIONFS_SECTORSIZE`` – ROM disk sector size.
|
||||
|
||||
See the ``README.txt`` file at ``nuttx/boards/sim/sim/sim/README.txt`` for a
|
||||
walk-through of the output of this text.
|
||||
See :doc:`/platforms/sim/sim/boards/sim/index` page for a walk-through of the
|
||||
output of this text.
|
||||
|
||||
@ -7,8 +7,6 @@ Applications
|
||||
|
||||
NuttX ships a large number of applications covering a wide spectrum of functionality.
|
||||
These can be found in the `apps <https://github.com/apache/nuttx-apps>`_ repository.
|
||||
At the moment, these are documented in their individual README files so you can find
|
||||
more information at the repository.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@ -257,7 +257,5 @@ configuration at
|
||||
`boards/sim/sim/sim/configs/nsh <https://github.com/apache/nuttx/blob/master/boards/sim/sim/sim/configs/nsh/>`__.
|
||||
The ROMFS support files are provided at
|
||||
`boards/sim/include <https://github.com/apache/nuttx/blob/master/boards/sim/sim/sim/include/>`__
|
||||
and the
|
||||
`README.txt <https://github.com/apache/nuttx/blob/master/boards/sim/sim/sim/README.txt>`__
|
||||
file at the location provides detailed information about creating and
|
||||
modifying the ROMFS file system.
|
||||
and the :doc:`/platforms/sim/sim/boards/sim/index` page provides detailed
|
||||
information about creating and modifying the ROMFS file system.
|
||||
|
||||
@ -168,7 +168,7 @@ Configuring NuttX requires only copying::
|
||||
|
||||
tools\configure.bat <board>:<config-dir>
|
||||
|
||||
See ``tools/README.txt`` for more information about these scripts.
|
||||
See :doc:`tools/index` for more information about these scripts.
|
||||
|
||||
And if your application directory is not in the standard location (``../apps``
|
||||
or ``../apps-<version>``), then you should also specify the location of the
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
NXFFS
|
||||
=====
|
||||
|
||||
This README file contains information about the implementation of the NuttX
|
||||
This page contains information about the implementation of the NuttX
|
||||
wear-leveling FLASH file system, NXFFS.
|
||||
|
||||
General NXFFS organization
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
SMARTFS
|
||||
=======
|
||||
|
||||
This README file contains information about the implementation of the NuttX
|
||||
This page contains information about the implementation of the NuttX
|
||||
Sector Mapped Allocation for Really Tiny (SMART) FLASH file system, SMARTFS.
|
||||
|
||||
Features
|
||||
@ -116,7 +116,7 @@ have a smaller erase size available also. Vendors have different names
|
||||
for the smaller erase size; In the NuttX MTD layer it is called
|
||||
SUBSECTOR_ERASE. For FLASH devices that support the smaller erase size,
|
||||
this configuration item can be added to the underlying MTD driver, and
|
||||
SMART will use it. As of the writing of this README, only the
|
||||
SMART will use it. As of the writing of this page, only the
|
||||
drivers/mtd/m25px.c driver had support for SUBSECTOR_ERASE.
|
||||
|
||||
The BYTE_WRITE config option enables use of the underlying MTD driver's
|
||||
|
||||
@ -92,5 +92,5 @@ Example Configurations
|
||||
however, because the LPC1766 has insufficient RAM to support the THTTPD
|
||||
application in this configuration.
|
||||
|
||||
See the README.txt file in each of these board directories for additional
|
||||
See the documentation pages for each of these board for additional
|
||||
information about these configurations.
|
||||
|
||||
@ -42,7 +42,7 @@ doing this:
|
||||
before there is any need for time-related services.
|
||||
|
||||
Both of these steps are shown together in the following code sample at the
|
||||
end of this README file.
|
||||
end of this page.
|
||||
|
||||
Example Configuration
|
||||
=====================
|
||||
@ -84,7 +84,8 @@ force rebuilding of the ROMFS filesystem be removing some files::
|
||||
make
|
||||
|
||||
If you have problems building the simulator on your platform, check out
|
||||
nuttx/boards/sim/sim/sim/README.txt. You might find some help there.
|
||||
:doc:`/platforms/sim/sim/boards/sim/index`.
|
||||
You might find some help there.
|
||||
|
||||
Here is a sample run. I have not seen any errors in single stepping through
|
||||
the logic but neither am I certain that everything is working properly::
|
||||
|
||||
@ -217,8 +217,8 @@ Sub-Directories:
|
||||
|
||||
- ``mm/shm`` - The shared memory logic
|
||||
|
||||
The shared memory management logic has its own README file that can be
|
||||
found at ``Documentation/components/mm/shm.rst``.
|
||||
The shared memory management logic has its own page that can be
|
||||
found at :doc:`shm`.
|
||||
|
||||
I/O Buffers
|
||||
-----------
|
||||
|
||||
@ -487,9 +487,8 @@ configurations for building the simulation:
|
||||
The build will also fail to locate the X header files unless you
|
||||
install an X11 development package.
|
||||
|
||||
- Refer to the readme file in sim configuration
|
||||
`README.txt <https://github.com/apache/nuttx/blob/master/boards/sim/sim/sim/README.txt>`__
|
||||
file for additional information.
|
||||
- Refer to the :doc:`/platforms/sim/sim/boards/sim/index` file for
|
||||
additional information.
|
||||
|
||||
**Test Coverage**. At present, ``apps/examples/nx``\ t only exercises a
|
||||
subset of NX; the remainder is essentially untested. The following table
|
||||
|
||||
@ -56,7 +56,7 @@ configure.sh configure.bat configure.c, cfgparser.c, and cfgparser.h
|
||||
|
||||
configure.sh is a bash script that is used to configure NuttX for a given
|
||||
target board in a environment that supports POSIX paths (Linux, Cygwin,
|
||||
macOS, or similar). See boards/README.txt or Documentation/NuttXPortingGuide.html
|
||||
macOS, or similar). See :doc:`/components/boards` or Documentation/NuttXPortingGuide.html
|
||||
for a description of how to configure NuttX with this script.
|
||||
|
||||
configure.c, cfgparser.c, and cfgparser.h can be used to build a work-alike
|
||||
@ -190,7 +190,7 @@ These are C files that are used to build mkconfig program. The mkconfig
|
||||
program is used during the initial NuttX build.
|
||||
|
||||
When you configure NuttX, you will copy a configuration file called .config
|
||||
in the top level NuttX directory (See boards/README.txt or
|
||||
in the top level NuttX directory (See :doc:`/components/boards` or
|
||||
Documentation/NuttXPortingGuide.html). The first time you make NuttX,
|
||||
the top-level makefile will build the mkconfig executable from mkconfig.c
|
||||
(using Makefile.host). The top-level Makefile will then execute the mkconfig
|
||||
@ -284,7 +284,7 @@ kernel function call (in kernel-mode) on behalf of the proxy function.
|
||||
Information about the stubs and proxies is maintained in a comma separated
|
||||
value (CSV) file in the syscall/ directory. The mksyscall program will
|
||||
accept this CVS file as input and generate all of the required proxy or
|
||||
stub files as output. See syscall/README.txt for additional information.
|
||||
stub files as output. See :doc:`/components/syscall` for additional information.
|
||||
|
||||
mksymtab.c, cvsparser.c, and cvsparser.h
|
||||
----------------------------------------
|
||||
@ -805,7 +805,7 @@ mkdeps.c, cnvwindeps.c, mkwindeps.sh, and mknulldeps.sh
|
||||
NuttX uses the GCC compiler's capabilities to create Makefile dependencies.
|
||||
The program mkdeps is used to run GCC in order to create the dependencies.
|
||||
If a NuttX configuration uses the GCC toolchain, its Make.defs file (see
|
||||
boards/README.txt) will include a line like::
|
||||
:doc:`/components/boards`) will include a line like::
|
||||
|
||||
MKDEP = $(TOPDIR)/tools/mkdeps[.exe] (See NOTE below)
|
||||
|
||||
@ -846,8 +846,8 @@ General usage:
|
||||
Usage: tools/netusb.sh <main-interface> <usb-net-interface> <on|off>
|
||||
|
||||
This has been tested on the SAMA5D3-Xplained board; see
|
||||
`boards/arm/sama5/sama5d3-xplained/README.txt` for more information on how
|
||||
to configure the CDC ECM driver for that board.
|
||||
`Documentation/platforms/arm/sama5/boards/sama5d3-xplained/README.txt`
|
||||
for more information on how to configure the CDC ECM driver for that board.
|
||||
|
||||
refresh.sh
|
||||
----------
|
||||
|
||||
@ -240,11 +240,11 @@ Example Code
|
||||
|
||||
You can find an example that tests the high priority, nested interrupts in the NuttX source:
|
||||
|
||||
* nuttx/boards/arm/stm32/viewtool-stm32f107/README.txt. Description of
|
||||
* :doc:`/platforms/arm/stm32f1/boards/viewtool-stm32f107/index` Description of
|
||||
the configuration
|
||||
|
||||
* nuttx/boards/arm/stm32/viewtool-stm32f107/highpri. Test configuration
|
||||
* ``nuttx/boards/arm/stm32/viewtool-stm32f107/highpri`` Test configuration
|
||||
|
||||
* nuttx/boards/arm/stm32/viewtool-stm32f107/src/stm32_highpri. Test
|
||||
* ``nuttx/boards/arm/stm32/viewtool-stm32f107/src/stm32_highpri`` Test
|
||||
driver.
|
||||
|
||||
|
||||
@ -349,10 +349,7 @@ contents of these configuration files.
|
||||
Supported Boards
|
||||
----------------
|
||||
|
||||
All of the specific boards supported by NuttX are identified in
|
||||
the
|
||||
`README.txt <https://github.com/apache/nuttx/blob/master/boards/README.txt>`__
|
||||
file.
|
||||
The list of supported boards can be found in :ref:`Supported Platforms <platforms>`.
|
||||
|
||||
Adding a New Board Configuration
|
||||
--------------------------------
|
||||
@ -494,7 +491,7 @@ user-mode applications and the kernel-mode RTOS.
|
||||
This directory holds a collection of tools and scripts to simplify
|
||||
configuring, building and maintaining NuttX.
|
||||
|
||||
Refer to the README file in the ``tools`` directory for more
|
||||
Refer to the :doc:`/components/tools/index` page for more
|
||||
information about the individual files. Some of these tools are
|
||||
discussed below as well in the discussion of `configuring and
|
||||
building <#configandbuild>`__ NuttX.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user