kumquat-buildroot/docs/manual
Yann E. MORIN 84c825f8e8 core: add the possibility to provide help for custom rules
When using a br2-external tree, it is possible (as stated in our manual)
to implement whatever arbitrary extra make rules (such as flashing a
board, or extracting the rootfs in an NFS export...). Some of those
extra rules might be exposed to the user as new entry points that the
user can call by itself.

However, there is no way for the br2-external to advertise those new
rules in the help text.

We add the possibility to do so, by adding a new make rule, called
help-custom, advertised in our own help info.

It is up to the br2-external tree to provide whatever help text is
deemed necessary. The format of the help is completely free-form.

Note that we need to provide an empty, dummy help-custom rule, since it
is always advertised (making it .PHONY does not work). Since this rule
is empty, make gently reports that there is "Nothing to be done for
`help-local'", which is pretty well fitting when help-local was not
provided (either because there's no br2-external tree, or when the
br2-external tree does not provide it.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Jérôme Pouiller <jezz@sysmic.org>
Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2016-03-19 16:41:22 +01:00
..
adding-board-support.txt manual/developer guide: minor rework of 'adding board support' section 2014-09-21 19:41:12 +02:00
adding-packages-asciidoc.txt docs/manual: document the asciidoc infra 2014-10-12 07:46:28 +02:00
adding-packages-autotools.txt manual: Remove trailing space 2014-11-22 20:13:16 +01:00
adding-packages-cmake.txt pkg-cmake: allow to build package in a subdirectory 2015-03-13 22:34:43 +01:00
adding-packages-conclusion.txt manual: use one-line titles instead of two-line titles (trivial) 2014-05-02 10:27:59 +02:00
adding-packages-directory.txt arch: remove BR2_ARCH_HAS_ATOMICS option 2016-02-06 11:16:00 +01:00
adding-packages-generic.txt docs/manual: document format for specifying licenses 2016-03-06 21:52:57 +01:00
adding-packages-gettext.txt docs/manual: update documentation about gettext handling 2014-08-18 10:36:31 +02:00
adding-packages-hooks.txt infra: Add PRE_*_HOOKS for every step 2014-05-08 22:00:47 +02:00
adding-packages-kconfig.txt docs/manual: document the new kconfig-package variable 2015-12-22 22:39:26 +01:00
adding-packages-kernel-module.txt docs/manual: add documentation for linux-ext and linux-tools. 2015-07-14 23:35:58 +02:00
adding-packages-linux-kernel-spec-infra.txt docs/manual: add documentation for linux-ext and linux-tools. 2015-07-14 23:35:58 +02:00
adding-packages-luarocks.txt packages: rename FOO_BUILD_OPT into FOO_BUILD_OPTS 2014-10-04 18:54:30 +02:00
adding-packages-perl.txt packages: rename FOO_BUILD_OPT into FOO_BUILD_OPTS 2014-10-04 18:54:30 +02:00
adding-packages-python.txt docs/manual: add "python-package CFFI backend" section 2016-02-23 17:25:06 +01:00
adding-packages-rebar.txt docs/manual: add documentation for the pkg-rebar infrastructure 2015-02-03 10:23:03 +01:00
adding-packages-tips.txt docs/manual: Modify GitHub FOO_SITE explanation 2015-07-28 23:37:39 +02:00
adding-packages-virtual.txt docs/manual: add the virtual packages list 2014-06-08 17:11:47 +02:00
adding-packages.txt docs/manual: add documentation for linux-ext and linux-tools. 2015-07-14 23:35:58 +02:00
advanced.txt manual: high-level restructuring 2014-08-17 21:09:52 +02:00
appendix.txt manual: high-level restructuring 2014-08-17 21:09:52 +02:00
beyond-buildroot.txt docs/manual/beyond-buildroot: additional minor fixes 2015-07-10 19:17:02 +02:00
ccache-support.txt ccache: support changing the output directory 2015-10-04 18:22:21 +02:00
common-usage.txt docs/manual: update graph-depends documentation about --stop-on 2016-02-08 21:29:38 +01:00
configure-other-components.txt docs/manual: add U-Boot configuration 2015-07-19 14:47:11 +02:00
configure.txt system: clarify /dev management using devtmpfs + {mdev, eudev} 2015-10-04 11:23:14 +01:00
contribute.txt docs/manual/contribute.txt: add formatting patches section 2016-02-24 00:04:19 +01:00
customize-configuration.txt docs/manual: add U-Boot configuration 2015-07-19 14:47:11 +02:00
customize-device-permission-tables.txt manual: remove the extra whitespaces 2014-12-20 15:55:54 +01:00
customize-directory-structure.txt manual/user guide/customization: add section on layered customization 2014-09-21 19:41:12 +02:00
customize-outside-br.txt core: add the possibility to provide help for custom rules 2016-03-19 16:41:22 +01:00
customize-packages.txt manual: remove the extra whitespaces 2014-12-20 15:55:54 +01:00
customize-patches.txt docs/manual: update documentation about applying patches 2015-04-06 11:05:16 +02:00
customize-post-image.txt manual/user guide/customization: rework section on rootfs customization 2014-08-31 22:22:43 +02:00
customize-quick-guide.txt docs/manual: add U-Boot configuration 2015-07-19 14:47:11 +02:00
customize-rootfs.txt manual/user guide/customization: refer to dir structure from rootfs section 2014-09-21 19:41:12 +02:00
customize-users-tables.txt manual/user guide/customization: add section on users tables 2014-09-21 19:41:12 +02:00
customize.txt manual/user guide/customization: rework 'step-by-step instructions' 2014-09-21 19:41:12 +02:00
debugging-buildroot.txt docs/manual: add list of instrumentation steps 2015-05-05 22:47:32 +02:00
download-infra.txt manual: use one-line titles instead of two-line titles (trivial) 2014-05-02 10:27:59 +02:00
download-location.txt docs/manual: fix bash export syntax in example code 2015-11-11 23:12:30 +01:00
eclipse-integration.txt manual/user guide: high-level restructuring 2014-08-21 15:39:32 +02:00
faq-troubleshooting.txt docs/manual: add FAQ entry about speeding up the build process 2015-02-03 15:15:27 +01:00
getting.txt docs/manual: misc improvements to Vagrant usage documentation 2016-02-08 13:33:43 +01:00
how-buildroot-works.txt manual/user guide: high-level restructuring 2014-08-21 15:39:32 +02:00
introduction.txt manual: high-level restructuring 2014-08-17 21:09:52 +02:00
known-issues.txt manual: high-level restructuring 2014-08-17 21:09:52 +02:00
legal-notice.txt docs/manual: add section about patch licensing 2016-03-01 12:46:58 +01:00
make-tips.txt docs/manual: add U-Boot configuration 2015-07-19 14:47:11 +02:00
makedev-syntax.txt docs/manual: makedev syntax accepts usernames and group names 2016-02-01 08:02:38 +01:00
makeusers-syntax.txt scripts/mkusers: allow users with no password value set 2015-06-09 23:13:41 +02:00
manual.mk docs/manual: do not override BR2_EXTERNAL 2015-11-03 23:42:24 +01:00
manual.txt manual: move 'Creating your own board support' from User to Developer guide 2014-09-21 19:41:12 +02:00
package-make-target.txt docs/manual: reinstall target 2015-02-03 18:08:32 +01:00
patch-policy.txt docs/manual: add section about patch licensing 2016-03-01 12:46:58 +01:00
prerequisite.txt docs/manual: relax python version requirement 2015-07-14 23:56:35 +02:00
quickstart.txt manual: remove the extra whitespaces 2014-12-20 15:55:54 +01:00
rebuilding-packages.txt manual: use one-line titles instead of two-line titles (trivial) 2014-05-02 10:27:59 +02:00
resources.txt docs: use lists.buildroot.org to refer to the mailman archives 2015-09-14 14:50:40 +02:00
using-buildroot-debugger.txt manual: high-level restructuring 2014-08-17 21:09:52 +02:00
using-buildroot-development.txt manual: high-level restructuring 2014-08-17 21:09:52 +02:00
using-buildroot-toolchain.txt manual: remove the extra whitespaces 2014-12-20 15:55:54 +01:00
writing-rules.txt Document the 72 char limit on package description. 2015-07-13 12:16:45 +02:00