diff options
author | Thomas De Schampheleire <patrickdepinguin@gmail.com> | 2014-08-12 22:20:06 +0200 |
---|---|---|
committer | Thomas Petazzoni <thomas.petazzoni@free-electrons.com> | 2014-08-17 21:09:52 +0200 |
commit | 569db405741dfee119ebb211722f588557b83542 (patch) | |
tree | 41f6fe67c0b5d1b5f114d7a4a07c4e53921c05bd /docs/manual/manual.txt | |
parent | 7fa43f911be83555df8789e4739816e762e1ff26 (diff) | |
download | buildroot-569db405741dfee119ebb211722f588557b83542.tar.gz buildroot-569db405741dfee119ebb211722f588557b83542.zip |
manual: high-level restructuring
The structure of the buildroot manual is not always clear. There is a large
number of chapters, and some chapters seem to overlap. The distinction
between general usage and developer information is not always clear.
This patch restructures the manual into four large parts:
- getting started
- user guide
- developer guide
- appendix
Except for the names of these parts, the section names are not yet changed.
Content-wise there are no changes yet either. This will be handled in
subsequent patches.
In order to achieve the introduction of a new level 'parts' above
'chapters', the section indicators (=, ==, ===, ...) of several sections
have to be moved one level down. Additionally, the leveloffset indication to
asciidoc has to be removed. Finally, to maintain more or less the same level
of detail in the table of contents, the toc.section.depth attribute is
reduced as well. Note that for some sections, less detail is visible now.
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Diffstat (limited to 'docs/manual/manual.txt')
-rw-r--r-- | docs/manual/manual.txt | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt index bf89af9ee5..6730e5376a 100644 --- a/docs/manual/manual.txt +++ b/docs/manual/manual.txt @@ -16,12 +16,14 @@ Copyright (C) 2004-2014 The Buildroot developers image::logo.png[] -:leveloffset: 1 += Getting started include::introduction.txt[] include::starting-up.txt[] += User guide + include::working-with.txt[] include::faq-troubleshooting.txt[] @@ -30,14 +32,18 @@ include::known-issues.txt[] include::going-further.txt[] -include::developer-guide.txt[] - include::legal-notice.txt[] include::beyond-buildroot.txt[] += Developer guide + +include::developer-guide.txt[] + include::get-involved.txt[] include::contribute.txt[] += Appendix + include::appendix.txt[] |