Documentation/Make: add implementation/make_build_system.rst
Build Documentation / build-html (push) Has been cancelled

This commit adds initial high level overview of the NuttX
make-based build system.  It documents:
* Tools used during the build process
* Mechanisms set in place during the build process

Signed-off-by: Luchian Mihai <luchiann.mihai@gmail.com>
This commit is contained in:
LuchianMihai
2025-10-06 11:07:02 +03:00
committed by Matteo Golin
parent b2b045252d
commit e09c8e510e
4 changed files with 616 additions and 13 deletions
+6 -13
View File
@@ -13,19 +13,6 @@ cmpconfig.c
This C file can be used to build a utility for comparing two NuttX This C file can be used to build a utility for comparing two NuttX
configuration files. configuration files.
Config.mk
---------
Config.mk contains common definitions used by many configuration files.
This file (along with <nuttx>/.config) must be included at the top of
each configuration-specific Make.defs file like::
include $(TOPDIR)/.config
include $(TOPDIR)/tools/Config.mk
Subsequent logic within the configuration-specific Make.defs file may then
override these default definitions as necessary.
checkpatch.sh checkpatch.sh
------------- -------------
@@ -740,6 +727,8 @@ these problems::
- option env="APPSDIR" - option env="APPSDIR"
+ default "../apps" + default "../apps"
.. _build_system_linking:
link.sh, link.bat, copydir.sh, copydir.bat, unlink.sh, and unlink.bat link.sh, link.bat, copydir.sh, copydir.bat, unlink.sh, and unlink.bat
--------------------------------------------------------------------- ---------------------------------------------------------------------
@@ -780,6 +769,8 @@ this case. link.bat will attempt to create a symbolic link using the
NTFS mklink.exe command instead of copying files. That logic, however, NTFS mklink.exe command instead of copying files. That logic, however,
has not been verified as of this writing. has not been verified as of this writing.
.. _makefile_host:
Makefile.host Makefile.host
------------- -------------
@@ -801,6 +792,8 @@ may be mounted under /etc in the NuttX pseudo file system.
TIP: Edit the resulting header file and mark the generated data values TIP: Edit the resulting header file and mark the generated data values
as 'const' so that they will be stored in FLASH. as 'const' so that they will be stored in FLASH.
.. _mkdeps:
mkdeps.c, cnvwindeps.c, mkwindeps.sh, and mknulldeps.sh mkdeps.c, cnvwindeps.c, mkwindeps.sh, and mknulldeps.sh
------------------------------------------------------- -------------------------------------------------------
@@ -33,6 +33,8 @@ Answer
This is probably normal behavior. There are two separate, unrelated issues here. This is probably normal behavior. There are two separate, unrelated issues here.
.. _versioning:
Versioning Versioning
---------- ----------
+1
View File
@@ -6,6 +6,7 @@ Implementation Details
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
make_build_system.rst
drivers_design.rst drivers_design.rst
device_drivers.rst device_drivers.rst
processes_vs_tasks.rst processes_vs_tasks.rst
File diff suppressed because it is too large Load Diff