Re: [PATCH/RFC] newlib: update build system generation documentation

Corinna Vinschen <[email protected]>
Newsgroups gmane.comp.lib.newlib
Message-ID <[email protected]>
On Feb 17 00:52, Mike Frysinger wrote:
> Replace all of the individual autotool steps with a single autoreconf.
> This simplifies the documentation greatly, and in the current system,
> only takes ~10 seconds to regenerate everything.
> 
> Update the developer documentation to cover all the major components
> of the current build system.  Hopefully this is a fairly complete road
> map to everything.  I tried to include everything that I wish I knew
> when I started hacking on this :P.
> ---
> NB: this requires a few more patches i have pending/waiting review, so it
> isn't ready to merge just yet, but assuming the libm.a up-merging is OK
> (and it sounds like it is), i think this is ready for review.
> 
>  newlib/HOWTO  | 161 ++++++++++++++++++++++++++++++++++++++++++++++++++
>  newlib/NEWS   |   1 +
>  newlib/README |  94 ++++++++---------------------
>  3 files changed, 186 insertions(+), 70 deletions(-)
> [...]
> diff --git a/newlib/README b/newlib/README
> index aa48b246f968..a6645504cba9 100644
> --- a/newlib/README
> +++ b/newlib/README
> @@ -23,13 +23,18 @@ Unpacking and Installation -- quick overview
>  When you unpack the newlib-4.2.0.tar.gz file, you'll find a directory
>  called `newlib-4.2.0', which contains:
>  
> -COPYING          config/          install-sh*      mpw-configure
> -COPYING.LIB      config-ml.in     libgloss/        mpw-install
> -COPYING.NEWLIB   config.guess*    mkinstalldirs*   newlib/
> -CYGNUS           config.sub*      move-if-change*  symlink-tree*
> -ChangeLog        configure*       mpw-README       texinfo/
> -Makefile.in      configure.in     mpw-build.in
> -README           etc/             mpw-config.in
> +COPYING           README-maintainer-mode  include/        mkdep
> +COPYING.LIB       compile                 install-sh      mkinstalldirs
> +COPYING.LIBGLOSS  config/                 libgloss/       move-if-change
> +COPYING.NEWLIB    config-ml.in            libtool.m4      newlib/
> +COPYING3          config.guess            ltgcc.m4        setup.com
> +COPYING3.LIB      config.rpath            ltmain.sh       src-release
> +ChangeLog         config.sub              ltoptions.m4    symlink-tree
> +MAINTAINERS       configure               ltsugar.m4      texinfo/
> +Makefile.def      configure.ac            ltversion.m4    ylwrap
> +Makefile.in       depcomp                 lt~obsolete.m4
> +Makefile.tpl      djunpack.bat            makefile.vms
> +README            etc/                    missing

Seeing this, I wonder why we are documenting a list of top-level files,
most of which are of no further interest to the user anyway.  Maybe it
would make more sense to just mention a few of them, like, say,
"configure"?

Other than that, LGTM.

Thanks,
Corinna
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.