Ricardo Martincoski ad35a3a43d docs/manual: size of tab in package description ...

Explicitly state that one tab counts for 8 columns in package
description, leaving 62 characters to the text itself.
Update the text and the example in the two places where the Config.in
format is described.
Also mention a newline is expected between the help text itself and the
upstream URL.

This blob can help developers to understand the expected formatting.
Also, it can be referenced by reviewers.

http://patchwork.ozlabs.org/patch/611289/
http://patchwork.ozlabs.org/patch/606866/
http://patchwork.ozlabs.org/patch/459960/

Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Romain Naour <romain.naour@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

2017-04-08 16:15:36 +02: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 br2-external NAME

2016-10-16 13:01:02 +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

docs/manual: size of tab in package description

2017-04-08 16:15:36 +02:00

adding-packages-generic.txt

docs/manual: refer to SPDX License List

2017-04-01 15:11:18 +02:00

adding-packages-gettext.txt

docs/manual: update documentation about gettext handling

2014-08-18 10:36:31 +02:00

adding-packages-hooks.txt

core/pkg-generic: allow packages to declare target-finalize hooks

2016-07-05 15:48:48 +02:00

adding-packages-kconfig.txt

docs/manual: update pkg-kconfig doc about <pkg>_KCONFIG_DOTCONFIG

2016-09-17 14:46:04 +02:00

adding-packages-kernel-module.txt

docs/manual: refer to SPDX License List

2017-04-01 15:11:18 +02:00

adding-packages-linux-kernel-spec-infra.txt

docs/manual: update the linux tools section

2016-09-22 12:32:34 +02:00

adding-packages-luarocks.txt

luarocks-package: lowercase the upstream name for LuaRocks

2017-03-05 22:01:39 +01:00

adding-packages-perl.txt

docs/manual: refer to SPDX License List

2017-04-01 15:11:18 +02:00

adding-packages-python.txt

docs/manual: refer to SPDX License List

2017-04-01 15:11:18 +02: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

support/test-pkg: print number of toolchains and progress

2017-04-06 21:51:29 +02:00

adding-packages-virtual.txt

manual: get rid of the lists of packages

2016-09-19 19:32:59 +02:00

adding-packages-waf.txt

doc/manual: document the new waf-package infra variables

2016-12-11 18:03:59 +01:00

adding-packages.txt

docs/manual: document the test-pkg script

2017-04-06 21:50:59 +02:00

advanced.txt

manual: high-level restructuring

2014-08-17 21:09:52 +02:00

appendix.txt

docs/manual: add appendix to convert old br2-external trees

2016-10-16 13:01:02 +02:00

beyond-buildroot.txt

docs/manual/beyond-buildroot: additional minor fixes

2015-07-10 19:17:02 +02:00

br2-external-converting.txt

docs/manual: document multi br2-external

2016-10-16 13:01: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: centralize recommendations about BR2_DL_DIR

2017-02-07 14:55:02 +01:00

configure-other-components.txt

docs/manual: add U-Boot configuration

2015-07-19 14:47:11 +02:00

configure.txt

docs: update URL to uClibc-ng homepage

2016-10-14 16:49:35 +02:00

contribute.txt

docs/manual: refer to SPDX License List

2017-04-01 15:11:18 +02: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

docs/manual: document the br2-external NAME

2016-10-16 13:01:02 +02:00

customize-outside-br.txt

docs/manual: fix typo

2016-11-29 23:28:25 +01:00

customize-packages.txt

docs/manual: document the br2-external NAME

2016-10-16 13:01:02 +02: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

docs/manual: document BR2_ROOTFS_POST_FAKEROOT_SCRIPT

2016-07-04 15:22:57 +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

developers.txt

docs/manual: fix typo

2016-09-22 00:02:52 +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: centralize recommendations about BR2_DL_DIR

2017-02-07 14:55:02 +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

docs/manual/known-issues: remove occurrences of eglibc

2016-06-28 22:27:27 +02:00

legal-notice.txt

docs/manual: refer to SPDX License List

2017-04-01 15:11:18 +02:00

make-tips.txt

core: enhance printvars

2017-03-29 21:55:14 +02:00

makedev-syntax.txt

makedevs: add capability support

2016-06-30 12:13:38 +02:00

makeusers-syntax.txt

scripts/mkusers: allow users with no password value set

2015-06-09 23:13:41 +02:00

manual.mk

manual: get rid of the lists of packages

2016-09-19 19:32:59 +02:00

manual.txt

Makefile, manual: Bump copyright year

2017-01-27 19:10:22 +01:00

package-make-target.txt

docs/manual: reinstall target

2015-02-03 18:08:32 +01:00

patch-policy.txt

docs/manual: fix patch naming convention

2016-08-09 15:45:32 +02:00

prerequisite.txt

docs: Add bc to required tools

2017-01-06 12:18:30 +01: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: fix typo

2016-08-19 11:25:39 +02:00

using-buildroot-toolchain.txt

manual: remove the extra whitespaces

2014-12-20 15:55:54 +01:00

writing-rules.txt

docs/manual: size of tab in package description

2017-04-08 16:15:36 +02:00