Patchwork [v2,03/11] manual: add prerequisite.txt

login
register
mail settings
Submitter Samuel Martin
Date May 13, 2012, 10:38 a.m.
Message ID <1336905501-9757-4-git-send-email-s.martin49@gmail.com>
Download mbox | patch
Permalink /patch/158814/
State Superseded
Headers show

Comments

Samuel Martin - May 13, 2012, 10:38 a.m.
From: Samuel MARTIN <s.martin49@gmail.com>


Signed-off-by: Samuel Martin <s.martin49@gmail.com>

 create mode 100644 docs/manual/prerequisite.txt
Thomas De Schampheleire - May 16, 2012, 4:32 p.m.
On Sun, May 13, 2012 at 12:38 PM, Samuel Martin <s.martin49@gmail.com> wrote:
> From: Samuel MARTIN <s.martin49@gmail.com>
>
>
> Signed-off-by: Samuel Martin <s.martin49@gmail.com>
>
>  create mode 100644 docs/manual/prerequisite.txt
>
> diff --git a/docs/manual/prerequisite.txt b/docs/manual/prerequisite.txt
> new file mode 100644
> index 0000000..6ed3072
> --- /dev/null
> +++ b/docs/manual/prerequisite.txt
> @@ -0,0 +1,62 @@
> +[[requirement]]
> +System requirements
> +-------------------
> +
> +Buildroot is design to run on Linux system.
> +
> +Buildroot needs some software to be already installed on the host
> +system; hereafter the lists of the mandatory and optional packages
> +(packages' name may vary between distribution).

I'm not a native English speaker, but I think "packages' name" is not correct.
I'd say "packages' names" or simply "package names".

s/distribution/distributions/

> +
> +Take care of _installing both runtime and development data_, especially
> +for the libraries that may be packaged in 2 distinct packages.
> +
> +
> +[[requirement-mandatory]]
> +
> +Mandatory packages
> +~~~~~~~~~~~~~~~~~~
> +
> +* Build tools:
> +** +build-essential+ (only for Debian based system)

s/system/systems/

> +** +gcc+
> +** +g+++
> +** +bison+
> +** +flex+
> +** +gettext+
> +** +patch+
> +
> +* Source fetching tools:
> +** +wget+
> +
> +* Development libraries:
> +** +ncurses5+

Isn't ncurses only needed for menuconfig, and so belongs in the list
'Configuration interface dependencies' ?

> +
> +[[requirement-optional]]
> +
> +Optional packages
> +~~~~~~~~~~~~~~~~~
> +
> +* Build tools:
> +** +gawk+
> +
> +* Source fetching tools:
> +** +cvs+
> +** +git+
> +** +mercurial+
> +** +subversion+

What's the reasoning behind these 'optional requirements' ?
People that are new to buildroot may simply install all 'requirements'
and hence install tools like cvs or one of the other version control
systems, while it won't actually be used, unless they select a package
that downloads using that method.
Moreover, some tools that could fit in this category are missing, like
bazaar or scp.

> +
> +* Configuration interface dependencies (requires development libraries):
> +** +qt4+ to use the 'xconfig' interface
> +** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
> +
> +* Development libraries:
> +** +zlib1+
> +** +netpbm10+ (for +fbtest+)
> +** +python-xcbgen+ (for +Matchbox+ on Debian based system)
> +// ** +jdk+ and and depending on the host system +gcj-compat+ for Java
> +// development (for +java+, +jamvm+ and +gnu-classpath+)
> +

I would think that the intention of buildroot is that most
non-standard dependencies are handled within buildroot.
One can safely expect make and gcc to be present, but is it currently
so that such things like netpbm10 are needed? If so, shouldn't they be
built as host-netpbm10 etc ?
If we can do that, the above section can be removed.
Otherwise:
s/and and/and/

> +* Documentation generation tools:
> +** +asciidoc+
> +** +texinfo+
> diff --git a/docs/manual/starting-up.txt b/docs/manual/starting-up.txt
> index 4f567f0..3a74ea6 100644
> --- a/docs/manual/starting-up.txt
> +++ b/docs/manual/starting-up.txt
> @@ -1,6 +1,8 @@
>  Starting up
>  ===========
>
> +include::prerequisite.txt[]
> +
>  include::getting.txt[]
>
>  include::using.txt[]
> --
> 1.7.10.2
>
> _______________________________________________
> buildroot mailing list
> buildroot@busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot
Samuel Martin - May 16, 2012, 9:45 p.m.
Hi Thomas,

Thx for the review.

2012/5/16 Thomas De Schampheleire <patrickdepinguin+buildroot@gmail.com>:
>> +
>> +[[requirement-optional]]
>> +
>> +Optional packages
>> +~~~~~~~~~~~~~~~~~
>> +
>> +* Build tools:
>> +** +gawk+
>> +
>> +* Source fetching tools:
>> +** +cvs+
>> +** +git+
>> +** +mercurial+
>> +** +subversion+
>
> What's the reasoning behind these 'optional requirements' ?
Actually, I followed the comments from Thomas P. on the first post, see:
http://lists.busybox.net/pipermail/buildroot/2012-March/051972.html

> People that are new to buildroot may simply install all 'requirements'
> and hence install tools like cvs or one of the other version control
> systems, while it won't actually be used, unless they select a package
> that downloads using that method.
> Moreover, some tools that could fit in this category are missing, like
> bazaar or scp.
You're right, I've omitted them and others...

>
>> +
>> +* Configuration interface dependencies (requires development libraries):
>> +** +qt4+ to use the 'xconfig' interface
>> +** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
>> +
>> +* Development libraries:
>> +** +zlib1+
>> +** +netpbm10+ (for +fbtest+)
>> +** +python-xcbgen+ (for +Matchbox+ on Debian based system)
>> +// ** +jdk+ and and depending on the host system +gcj-compat+ for Java
>> +// development (for +java+, +jamvm+ and +gnu-classpath+)
>> +
>
> I would think that the intention of buildroot is that most
> non-standard dependencies are handled within buildroot.
So am I.

> One can safely expect make and gcc to be present, but is it currently
> so that such things like netpbm10 are needed? If so, shouldn't they be
> built as host-netpbm10 etc ?
Sure. A new item on the todo list ;-)

To write this page, I got inspired from:
http://www.armadeus.com/wiki/index.php?title=Ubuntu/Debian_installation_prerequisites
BR moves fast and the Armadeus Project is not based on the latest release, so...

> If we can do that, the above section can be removed.
I agree.

> Otherwise:
> s/and and/and/
>


Cheers,

Sam
Thomas De Schampheleire - May 17, 2012, 6:53 a.m.
Op 16 mei 2012 23:46 schreef "Samuel Martin" <s.martin49@gmail.com> het
volgende:
>
> Hi Thomas,
>
> Thx for the review.
>
> 2012/5/16 Thomas De Schampheleire <patrickdepinguin+buildroot@gmail.com>:
> >> +
> >> +[[requirement-optional]]
> >> +
> >> +Optional packages
> >> +~~~~~~~~~~~~~~~~~
> >> +
> >> +* Build tools:
> >> +** +gawk+

Based on Thomas' post, is gawk really needed? As he says, host-gawk will be
built when required by a package.

> >> +
> >> +* Source fetching tools:
> >> +** +cvs+
> >> +** +git+
> >> +** +mercurial+
> >> +** +subversion+
> >
> > What's the reasoning behind these 'optional requirements' ?
> Actually, I followed the comments from Thomas P. on the first post, see:
> http://lists.busybox.net/pipermail/buildroot/2012-March/051972.html
>
> > People that are new to buildroot may simply install all 'requirements'
> > and hence install tools like cvs or one of the other version control
> > systems, while it won't actually be used, unless they select a package
> > that downloads using that method.
> > Moreover, some tools that could fit in this category are missing, like
> > bazaar or scp.
> You're right, I've omitted them and others...
>
> >
> >> +
> >> +* Configuration interface dependencies (requires development
libraries):
> >> +** +qt4+ to use the 'xconfig' interface
> >> +** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
> >> +
> >> +* Development libraries:
> >> +** +zlib1+
> >> +** +netpbm10+ (for +fbtest+)
> >> +** +python-xcbgen+ (for +Matchbox+ on Debian based system)
> >> +// ** +jdk+ and and depending on the host system +gcj-compat+ for Java
> >> +// development (for +java+, +jamvm+ and +gnu-classpath+)
> >> +
> >
> > I would think that the intention of buildroot is that most
> > non-standard dependencies are handled within buildroot.
> So am I.
>
> > One can safely expect make and gcc to be present, but is it currently
> > so that such things like netpbm10 are needed? If so, shouldn't they be
> > built as host-netpbm10 etc ?
> Sure. A new item on the todo list ;-)
>
> To write this page, I got inspired from:
>
http://www.armadeus.com/wiki/index.php?title=Ubuntu/Debian_installation_prerequisites
> BR moves fast and the Armadeus Project is not based on the latest
release, so...
>
> > If we can do that, the above section can be removed.
> I agree.
>
> > Otherwise:
> > s/and and/and/
> >
>
>
> Cheers,
>
> Sam

Patch

diff --git a/docs/manual/prerequisite.txt b/docs/manual/prerequisite.txt
new file mode 100644
index 0000000..6ed3072
--- /dev/null
+++ b/docs/manual/prerequisite.txt
@@ -0,0 +1,62 @@ 
+[[requirement]]
+System requirements
+-------------------
+
+Buildroot is design to run on Linux system.
+
+Buildroot needs some software to be already installed on the host
+system; hereafter the lists of the mandatory and optional packages
+(packages' name may vary between distribution).
+
+Take care of _installing both runtime and development data_, especially
+for the libraries that may be packaged in 2 distinct packages.
+
+
+[[requirement-mandatory]]
+
+Mandatory packages
+~~~~~~~~~~~~~~~~~~
+
+* Build tools:
+** +build-essential+ (only for Debian based system)
+** +gcc+
+** +g+++
+** +bison+
+** +flex+
+** +gettext+
+** +patch+
+
+* Source fetching tools:
+** +wget+
+
+* Development libraries:
+** +ncurses5+
+
+[[requirement-optional]]
+
+Optional packages
+~~~~~~~~~~~~~~~~~
+
+* Build tools:
+** +gawk+
+
+* Source fetching tools:
+** +cvs+
+** +git+
+** +mercurial+
+** +subversion+
+
+* Configuration interface dependencies (requires development libraries):
+** +qt4+ to use the 'xconfig' interface
+** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
+
+* Development libraries:
+** +zlib1+
+** +netpbm10+ (for +fbtest+)
+** +python-xcbgen+ (for +Matchbox+ on Debian based system)
+// ** +jdk+ and and depending on the host system +gcj-compat+ for Java
+// development (for +java+, +jamvm+ and +gnu-classpath+)
+
+* Documentation generation tools:
+** +asciidoc+
+** +texinfo+
diff --git a/docs/manual/starting-up.txt b/docs/manual/starting-up.txt
index 4f567f0..3a74ea6 100644
--- a/docs/manual/starting-up.txt
+++ b/docs/manual/starting-up.txt
@@ -1,6 +1,8 @@ 
 Starting up
 ===========
 
+include::prerequisite.txt[]
+
 include::getting.txt[]
 
 include::using.txt[]