Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Yann E. MORIN <yann.morin.1998@free.fr>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 0/23 v5] gendoc infra: make it useable for other documents (branch yem/manual)
Date: Sun, 14 Sep 2014 13:07:53 +0200	[thread overview]
Message-ID: <cover.1410692670.git.yann.morin.1998@free.fr> (raw)

Hello All!

This series builds up on top of Samuel previous series, and further
enhances the GENDOC infrastructure to be useable to generate other
documents, and especially documents in br2-external.

The series is articulated as thus:

  - patches 1-4 from Samuel, virtually untouched by me, save for the
    check for xsltproc, see the changelog in patch 4;

  - then, patches 5-16 to remove hard-coded reference to 'manual'
    in either GENDOC or GENDOC_INNER, and to remove hard-coded paths to
    our manual, and to properly separate GENDOC generic rules from
    document-specific rules, and make GENDOC look more like the
    pkg-XXX infrastructures;

  - finally, patches 17-18 allow building document from br2-external.

There are a few shortcomings here and there, be sure to read the
post-commit notes.


Changes v4 -> v5:
  - cleanup the series
  - make it posible to use $(@D) in hooks
  - call post-extract hook in the same rule that does the rsync
  - rename the extra check dependencies hooks, to look more like real hooks
  - document the doc-asciidoc infra in the manual

Changes v3 -> v4:
  - only run the xsltproc check once, not for every types of outputs
  - add patches 5..18


Regards,
Yann E. MORIN.


The following changes since commit 52fac6a2f7bba55fb78a7a1354eef7be5bba9f78:

  libelf: Removes the package (2014-09-14 00:11:20 +0200)

are available in the git repository at:

  git://gitorious.org/buildroot/buildroot.git yem/manual

for you to fetch changes up to cace268e0a2d0419476bc7c1952f753857a863a3:

  docs/manual: document the asciidoc infra (2014-09-14 11:33:34 +0200)

----------------------------------------------------------------
Samuel Martin (4):
      gendoc infra: cosmetic fixes
      gendoc infra: move manual build location into $(BUILD_DIR)/manual
      gendoc infra: avoid a2x warning
      gendoc infra: disable pdf manual generation if xsltproc is buggy

Yann E. MORIN (19):
      docs/manual: get rid of legacy comment in GENDOC
      docs/manual: copying the manual sources is a common action
      docs/manual: simplify generation dependencies
      docs/manual: manual-update-lists is not a generic GENDOC rule
      docs/manual: move manual-prepare-sources rule into GENDOC
      docs/manual: do not hardcode name of the generated document
      docs/manual: allow a document to declare where its ressources are
      docs/manual: last pass at removing hard-coded path in GENDOC_INNER
      docs/manual: properly separate rules specific for our manual
      docs/manual: rename the generic dependency rules
      docs/manual: allow documents to define some hooks, as for a package
      docs/manual: use the new hooks instead of gendoc rules
      docs/manual: always look for ressources in destination directory
      docs: separate the GENDOC infra from our manual definition
      docs: rename the GENDOC infrastructure
      docs/asciidoc: call $(pkgname) and $(pkgdir) in a single place
      docs/asciidoc: make it possible to use $(@D) in hooks
      Makefile: enable generating documents from br2-external
      docs/manual: document the asciidoc infra

 Makefile                                 |   2 +
 docs/manual/adding-packages-asciidoc.txt | 118 +++++++++++++++++++++++
 docs/manual/adding-packages.txt          |   2 +
 docs/manual/manual.mk                    | 104 ++++-----------------
 package/doc-asciidoc.mk                  | 156 +++++++++++++++++++++++++++++++
 5 files changed, 294 insertions(+), 88 deletions(-)
 create mode 100644 docs/manual/adding-packages-asciidoc.txt
 create mode 100644 package/doc-asciidoc.mk

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

             reply	other threads:[~2014-09-14 11:07 UTC|newest]

Thread overview: 83+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-09-14 11:07 Yann E. MORIN [this message]
2014-09-14 11:07 ` [Buildroot] [PATCH 01/23 v5] gendoc infra: cosmetic fixes Yann E. MORIN
2014-09-21 18:11   ` Thomas Petazzoni
2014-09-14 11:07 ` [Buildroot] [PATCH 02/23 v5] gendoc infra: move manual build location into $(BUILD_DIR)/manual Yann E. MORIN
2014-09-21 19:13   ` Thomas Petazzoni
2014-09-21 19:43     ` Yann E. MORIN
2014-09-14 11:07 ` [Buildroot] [PATCH 03/23 v5] gendoc infra: avoid a2x warning Yann E. MORIN
2014-09-14 11:07 ` [Buildroot] [PATCH 04/23 v5] gendoc infra: disable pdf manual generation if xsltproc is buggy Yann E. MORIN
2014-09-19 20:00   ` Thomas De Schampheleire
2014-09-19 20:15     ` Yann E. MORIN
2014-09-19 20:21       ` Thomas De Schampheleire
2014-09-14 11:07 ` [Buildroot] [PATCH 05/23 v5] docs/manual: get rid of legacy comment in GENDOC Yann E. MORIN
2014-09-19 19:44   ` Thomas De Schampheleire
2014-09-22 19:56   ` Samuel Martin
2014-09-14 11:07 ` [Buildroot] [PATCH 06/23 v5] docs/manual: copying the manual sources is a common action Yann E. MORIN
2014-09-19 20:13   ` Thomas De Schampheleire
2014-09-22 19:56   ` Samuel Martin
2014-09-14 11:07 ` [Buildroot] [PATCH 07/23 v5] docs/manual: simplify generation dependencies Yann E. MORIN
2014-09-19 20:18   ` Thomas De Schampheleire
2014-09-22 21:05     ` Yann E. MORIN
2014-09-22 19:56   ` Samuel Martin
2014-09-14 11:07 ` [Buildroot] [PATCH 08/23 v5] docs/manual: manual-update-lists is not a generic GENDOC rule Yann E. MORIN
2014-09-22 18:58   ` Thomas De Schampheleire
2014-09-22 19:56   ` Samuel Martin
2014-09-14 11:07 ` [Buildroot] [PATCH 09/23 v5] docs/manual: move manual-prepare-sources rule into GENDOC Yann E. MORIN
2014-09-22 19:01   ` Thomas De Schampheleire
2014-09-22 19:56   ` Samuel Martin
2014-09-14 11:07 ` [Buildroot] [PATCH 10/23 v5] docs/manual: do not hardcode name of the generated document Yann E. MORIN
2014-09-22 19:21   ` Thomas De Schampheleire
2014-09-22 19:57   ` Samuel Martin
2014-09-14 11:07 ` [Buildroot] [PATCH 11/23 v5] docs/manual: allow a document to declare where its ressources are Yann E. MORIN
2014-09-22 19:26   ` Thomas De Schampheleire
2014-09-22 19:43     ` Thomas De Schampheleire
2014-09-14 11:07 ` [Buildroot] [PATCH 12/23 v5] docs/manual: last pass at removing hard-coded path in GENDOC_INNER Yann E. MORIN
2014-09-22 19:38   ` Thomas De Schampheleire
2014-09-23 17:21     ` Yann E. MORIN
2014-09-24  6:54       ` Thomas De Schampheleire
2014-09-24  7:36         ` Samuel Martin
2014-09-24 20:17         ` Yann E. MORIN
2014-09-14 11:07 ` [Buildroot] [PATCH 13/23 v5] docs/manual: properly separate rules specific for our manual Yann E. MORIN
2014-09-22 19:47   ` Thomas De Schampheleire
2014-09-14 11:07 ` [Buildroot] [PATCH 14/23 v5] docs/manual: rename the generic dependency rules Yann E. MORIN
2014-09-22 20:20   ` Samuel Martin
2014-09-24 18:57   ` Thomas De Schampheleire
2014-09-14 11:07 ` [Buildroot] [PATCH 15/23 v5] docs/manual: allow documents to define some hooks, as for a package Yann E. MORIN
2014-09-22 20:20   ` Samuel Martin
2014-09-24 19:11   ` Thomas De Schampheleire
2014-09-24 21:00     ` Yann E. MORIN
2014-09-14 11:07 ` [Buildroot] [PATCH 16/23 v5] docs/manual: use the new hooks instead of gendoc rules Yann E. MORIN
2014-09-22 20:20   ` Samuel Martin
2014-09-24 19:18   ` Thomas De Schampheleire
2014-09-14 11:07 ` [Buildroot] [PATCH 17/23 v5] docs/manual: always look for ressources in destination directory Yann E. MORIN
2014-09-22 20:20   ` Samuel Martin
2014-09-24 19:21   ` Thomas De Schampheleire
2014-09-25 19:31     ` Yann E. MORIN
2014-09-26 10:50       ` Thomas De Schampheleire
2014-09-26 16:56         ` Yann E. MORIN
2014-09-14 11:07 ` [Buildroot] [PATCH 18/23 v5] docs: separate the GENDOC infra from our manual definition Yann E. MORIN
2014-09-22 20:42   ` Samuel Martin
2014-09-23 21:56     ` Yann E. MORIN
2014-09-24 19:28   ` Thomas De Schampheleire
2014-09-14 11:07 ` [Buildroot] [PATCH 19/23 v5] docs: rename the GENDOC infrastructure Yann E. MORIN
2014-09-22 20:42   ` Samuel Martin
2014-09-24 19:31   ` Thomas De Schampheleire
2014-09-24 21:06     ` Yann E. MORIN
2014-09-14 11:07 ` [Buildroot] [PATCH 20/23 v5] docs/asciidoc: call $(pkgname) and $(pkgdir) in a single place Yann E. MORIN
2014-09-22 20:42   ` Samuel Martin
2014-09-24 19:44   ` Thomas De Schampheleire
2014-09-24 21:16     ` Yann E. MORIN
2014-09-14 11:07 ` [Buildroot] [PATCH 21/23 v5] docs/asciidoc: make it possible to use $(@D) in hooks Yann E. MORIN
2014-09-22 20:48   ` Samuel Martin
2014-09-24 19:50   ` Thomas De Schampheleire
2014-09-25 17:47     ` Yann E. MORIN
2014-09-14 11:07 ` [Buildroot] [PATCH 22/23 v5] Makefile: enable generating documents from br2-external Yann E. MORIN
2014-09-22 20:48   ` Samuel Martin
2014-09-24 19:52   ` Thomas De Schampheleire
2014-09-14 11:07 ` [Buildroot] [PATCH 23/23 v5] docs/manual: document the asciidoc infra Yann E. MORIN
2014-09-22 21:00   ` Samuel Martin
2014-09-24 20:07   ` Thomas De Schampheleire
2014-09-24 20:16     ` Thomas De Schampheleire
2014-09-25 22:21     ` Yann E. MORIN
2014-09-26 10:48       ` Thomas De Schampheleire
2014-09-14 11:21 ` [Buildroot] [PATCH 0/23 v5] gendoc infra: make it useable for other documents (branch yem/manual) Yann E. MORIN

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1410692670.git.yann.morin.1998@free.fr \
    --to=yann.morin.1998@free.fr \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox