Bruno ! You saved my day !
I put your description with some small amendments into the README. Here's the patch. With Best Regards, Tim On 05/16/2017 03:17 PM, Bruno Haible wrote: > Hi Tim, > >> Not sure how to build and run the test suite. The README just points me >> to a .texi file which is hardly readable, at least I get a headache >> after ~10s. > > I agree. The README should better say to > $ cd doc > $ make gnulib.html > $ xdg-open gnulib.html > or read the manual at > https://www.gnu.org/software/gnulib/manual/gnulib.html > >> What else should I try to build + run the test suite ? > > You first pick a subset of the Gnulib modules, that you want to work on. > Then you create a testdir for these modules: > > $ ./gnulib-tool --create-testdir --dir=../testdir1 --single-configure MODULE1 > [MODULE2...] > > This testdir is something you can "./configure CPPFLAGS=-Wall && make && make > check". > > For the set of Gnulib modules: > - If you don't specify any, it defaults to *all*! > - There is a script 'posix-modules' that returns the POSIX related modules. > Use like this: > $ ./gnulib-tool --create-testdir --dir=../testdir-posix > --single-configure `./posix-modules` > > Note the difference between --dir=../testdir1 and --dir=/tmp/testdir1 : The > former is on the > same file system as the gnulib checkout, and uses hard links to the .c and .h > files; therefore > for quick edits of only .h and .c files you can do the edits in the testdir, > test them > through "make" and "make check", and will usually find them present in the > gnulib clone. > In the second case, or when you start to edit .m4 files or module > descriptions, it's useful > to work in the gnulib clone, and repeatedly rerun the commands: > $ ./gnulib-tool --create-testdir --dir=../testdir2 --single-configure > MODULE1 [MODULE2...] > $ cd ../testdir2 > $ ./configure CPPFLAGS=-Wall && make && make check > > Bruno > >
From b7f51c73eb29c6be32232496ef130b13268be968 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20R=C3=BChsen?= <tim.rueh...@gmx.de> Date: Tue, 16 May 2017 15:43:11 +0200 Subject: [PATCH] README: Add notes for first-time contributors * README: Add text written by Bruno Haible --- README | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README b/README index 0191f7a93..6ef131872 100644 --- a/README +++ b/README @@ -1 +1,36 @@ -Please see doc/gnulib-readme.texi for basic information about Gnulib. +Please create and read the docs with + + $ cd doc + $ make gnulib.html + $ xdg-open gnulib.html + +or read the online manual at + + https://www.gnu.org/software/gnulib/manual/gnulib.html + + +#### Contributor's Quick Start Guide #### + +First pick a subset of the Gnulib modules, that you want to work on. +To create a testdir for these modules: + + $ ./gnulib-tool --create-testdir --dir=../testdir1 --single-configure MODULE1 [MODULE2...] + +This testdir is something you can "./configure CPPFLAGS=-Wall && make && make check". + +For the set of Gnulib modules: + - If you don't specify any, it defaults to *all*! + - There is a script 'posix-modules' that returns the POSIX related modules. Use like this: + + $ ./gnulib-tool --create-testdir --dir=../testdir-posix --single-configure `./posix-modules` + +Note the difference between --dir=../testdir1 and --dir=/tmp/testdir1 : The former is on the +same file system as the gnulib checkout, and uses hard links to the .c and .h files; therefore +for quick edits of only .h and .c files you can do the edits in the testdir, test them +through "make" and "make check", and will usually find them present in the gnulib clone. +In the second case, or when you start to edit .m4 files or module descriptions, it's useful +to work in the gnulib clone, and repeatedly rerun the commands: + + $ ./gnulib-tool --create-testdir --dir=../testdir2 --single-configure MODULE1 [MODULE2...] + $ cd ../testdir2 + $ ./configure CPPFLAGS=-Wall && make && make check -- 2.11.0
signature.asc
Description: OpenPGP digital signature
