Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
To: buildroot@busybox.net
Subject: [Buildroot] 2011.11: manual improvements
Date: Wed, 23 Nov 2011 09:47:52 +0100	[thread overview]
Message-ID: <20111123094752.076f5383@skate> (raw)
In-Reply-To: <CAAXf6LWh3_+8zwBjaJkpFH05+J=oSSPZbztZuNsoAVOKmGRuXw@mail.gmail.com>

Le Wed, 23 Nov 2011 09:37:49 +0100,
Thomas De Schampheleire <patrickdepinguin+buildroot@gmail.com> a ?crit :

> Alternatively, we could add a symbolic link from docs/manual to
> output/docs/manual, and put the link under version control.

No. The output is not necessarily in output/. With the O= option, you
can put it wherever you want (that's the point of out-of-tree build).

> But, this has the downside of having manuals in two places: the
> official manual distributed with a release tarball and the generated
> manual in output/docs.

I simply think it's a matter of :

 * Having generated versions of the manual in the release tarball

 * Having generated versions of the manual on the Buildroot website.
   Actually, I think people will more naturally search on the project
   website for documentation rather than inside the tarball. These
   days, everybody 'googles something' before running 'man something' :)

 * Documenting how to generate the manual.

Thomas
-- 
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com

  reply	other threads:[~2011-11-23  8:47 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-15 10:55 [Buildroot] 2011.11: manual improvements Thomas De Schampheleire
2011-11-23  7:23 ` Thomas De Schampheleire
2011-11-23  8:23   ` Thomas Petazzoni
2011-11-23  8:37     ` Thomas De Schampheleire
2011-11-23  8:47       ` Thomas Petazzoni [this message]
2011-11-23  8:56         ` Thomas De Schampheleire
2011-11-23  9:03         ` Stephan Hoffmann

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=20111123094752.076f5383@skate \
    --to=thomas.petazzoni@free-electrons.com \
    --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