[git pull] documentation directory

[git pull] documentation directory

[Sami Kerola]

The following changes since commit d1a1e0b71601d88a6157c35caf9184a5aa7b978c:

  docs: remove README.namei (2011-08-02 14:30:52 +0200)

are available in the git repository at:
  https://github.com/kerolasa/lelux-utiliteetit docs-dir

I would not be surprised that these changes would require a bit of
discussion, and few rejects, before the Documentation/ is done to
upstream. For instance you might disagree with contents of
00-about-docs.txt, and perhaps example.files/ should be deleted.

Sami Kerola (4):
      docs: remove README.clear
      docs: Documentation directory added
      docs: add usage() howto for contributors
      docs: tell what the Documentation/ is about

 Documentation/00-about-docs.txt                    |   29 ++++++++
 README.devel => Documentation/README.devel         |    0
 .../ReleaseNotes}/v2.13-ReleaseNotes               |    0
 .../ReleaseNotes}/v2.14-ReleaseNotes               |    0
 .../ReleaseNotes}/v2.15-ReleaseNotes               |    0
 .../ReleaseNotes}/v2.16-ReleaseNotes               |    0
 .../ReleaseNotes}/v2.17-ReleaseNotes               |    0
 .../ReleaseNotes}/v2.18-ReleaseNotes               |    0
 .../ReleaseNotes}/v2.19-ReleaseNotes               |    0
 .../ReleaseNotes}/v2.20-ReleaseNotes               |    0
 TODO => Documentation/TODO                         |    3 +-
 libblkid/README.blkid => Documentation/blkid.txt   |    0
 misc-utils/README.cal => Documentation/cal.txt     |    0
 fdisk/README.cfdisk => Documentation/cfdisk.txt    |    0
 text-utils/README.col => Documentation/col.txt     |    0
 misc-utils/README.ddate => Documentation/ddate.txt |    0
 DEPRECATED => Documentation/deprecated.txt         |    0
 .../example.files}/filesystems                     |    0
 .../example.files}/fstab                           |    0
 .../example.files}/inittab                         |    0
 .../example.files}/issue                           |    0
 .../example.files}/issue0                          |    0
 .../example.files}/motd                            |    0
 .../example.files}/securetty                       |    0
 .../example.files}/shells                          |    0
 .../example.files}/udev-raw.rules                  |    0
 fdisk/README.fdisk => Documentation/fdisk.txt      |    0
 getopt/README => Documentation/getopt.txt          |    0
 .../getopt_changelog.txt                           |    0
 .../README.hwclock => Documentation/hwclock.txt    |    0
 {licenses => Documentation/licenses}/COPYING.GPL   |    0
 {licenses => Documentation/licenses}/COPYING.UCB   |    0
 .../licenses/COPYING.getopt                        |    0
 .../licenses}/COPYING.libblkid                     |    0
 .../licenses}/COPYING.libmount                     |    0
 .../licenses}/COPYING.libuuid                      |    0
 {text-utils => Documentation/licenses}/LICENSE.pg  |    0
 README.licensing => Documentation/licensing.txt    |    0
 .../modems-with-agetty.txt                         |    0
 mount/README.mount => Documentation/mount.txt      |    0
 text-utils/README.pg => Documentation/pg.txt       |    0
 .../README.poeigl => Documentation/poeigl.txt      |    0
 fdisk/sfdisk.examples => Documentation/sfdisk.txt  |    0
 tests/README => Documentation/tests.txt            |    0
 Documentation/usage-howto.txt                      |   73 ++++++++++++++++++++
 Makefile.am                                        |    8 +--
 fdisk/Makefile.am                                  |    2 +-
 getopt/Makefile.am                                 |    3 -
 hwclock/Makefile.am                                |    2 -
 libblkid/Makefile.am                               |    2 +-
 libmount/Makefile.am                               |    2 +-
 libuuid/Makefile.am                                |    2 +-
 login-utils/Makefile.am                            |    2 -
 misc-utils/Makefile.am                             |    2 -
 mount/Makefile.am                                  |    2 -
 term-utils/Makefile.am                             |    4 +-
 tests/Makefile.am                                  |    1 -
 text-utils/Makefile.am                             |    4 -
 text-utils/README.clear                            |    7 --
 59 files changed, 109 insertions(+), 39 deletions(-)
 create mode 100644 Documentation/00-about-docs.txt
 rename README.devel => Documentation/README.devel (100%)
 rename {docs => Documentation/ReleaseNotes}/v2.13-ReleaseNotes (100%)
 rename {docs => Documentation/ReleaseNotes}/v2.14-ReleaseNotes (100%)
 rename {docs => Documentation/ReleaseNotes}/v2.15-ReleaseNotes (100%)
 rename {docs => Documentation/ReleaseNotes}/v2.16-ReleaseNotes (100%)
 rename {docs => Documentation/ReleaseNotes}/v2.17-ReleaseNotes (100%)
 rename {docs => Documentation/ReleaseNotes}/v2.18-ReleaseNotes (100%)
 rename {docs => Documentation/ReleaseNotes}/v2.19-ReleaseNotes (100%)
 rename {docs => Documentation/ReleaseNotes}/v2.20-ReleaseNotes (100%)
 rename TODO => Documentation/TODO (99%)
 rename libblkid/README.blkid => Documentation/blkid.txt (100%)
 rename misc-utils/README.cal => Documentation/cal.txt (100%)
 rename fdisk/README.cfdisk => Documentation/cfdisk.txt (100%)
 rename text-utils/README.col => Documentation/col.txt (100%)
 rename misc-utils/README.ddate => Documentation/ddate.txt (100%)
 rename DEPRECATED => Documentation/deprecated.txt (100%)
 rename {example.files => Documentation/example.files}/filesystems (100%)
 rename {example.files => Documentation/example.files}/fstab (100%)
 rename {example.files => Documentation/example.files}/inittab (100%)
 rename {example.files => Documentation/example.files}/issue (100%)
 rename {example.files => Documentation/example.files}/issue0 (100%)
 rename {example.files => Documentation/example.files}/motd (100%)
 rename {example.files => Documentation/example.files}/securetty (100%)
 rename {example.files => Documentation/example.files}/shells (100%)
 rename {example.files => Documentation/example.files}/udev-raw.rules (100%)
 rename fdisk/README.fdisk => Documentation/fdisk.txt (100%)
 rename getopt/README => Documentation/getopt.txt (100%)
 rename getopt/Changelog => Documentation/getopt_changelog.txt (100%)
 rename hwclock/README.hwclock => Documentation/hwclock.txt (100%)
 rename {licenses => Documentation/licenses}/COPYING.GPL (100%)
 rename {licenses => Documentation/licenses}/COPYING.UCB (100%)
 rename getopt/COPYING => Documentation/licenses/COPYING.getopt (100%)
 rename {libblkid => Documentation/licenses}/COPYING.libblkid (100%)
 rename {libmount => Documentation/licenses}/COPYING.libmount (100%)
 rename {libuuid => Documentation/licenses}/COPYING.libuuid (100%)
 rename {text-utils => Documentation/licenses}/LICENSE.pg (100%)
 rename README.licensing => Documentation/licensing.txt (100%)
 rename term-utils/README.modems-with-agetty =>
Documentation/modems-with-agetty.txt (100%)
 rename mount/README.mount => Documentation/mount.txt (100%)
 rename text-utils/README.pg => Documentation/pg.txt (100%)
 rename login-utils/README.poeigl => Documentation/poeigl.txt (100%)
 rename fdisk/sfdisk.examples => Documentation/sfdisk.txt (100%)
 rename tests/README => Documentation/tests.txt (100%)
 create mode 100644 Documentation/usage-howto.txt
 delete mode 100644 text-utils/README.clear

-- 
   Sami Kerola
   http://www.iki.fi/kerolasa/

Re: [git pull] documentation directory

[Karel Zak]

On Sat, Aug 06, 2011 at 07:57:53PM +0200, Sami Kerola wrote:
> are available in the git repository at:
>   https://github.com/kerolasa/lelux-utiliteetit docs-dir
> 
> discussion, and few rejects, before the Documentation/ is done to
> upstream. For instance you might disagree with contents of
> 00-about-docs.txt, and perhaps example.files/ should be deleted.

 The 'Warning about content' in 00-about-docs.txt is too crazy :-)
 Let's:
 
  - cleanup the files
  - remove obsolete information
  - move valid information to the man pages
  - add info about authors to the AUTHORS file
 
 I have updated the example.files/ in the master branch.

>  README.devel => Documentation/README.devel         |    0

 see below

>  .../ReleaseNotes}/v2.13-ReleaseNotes               |    0

 What about to rename the directory to releases/ ? The NEWS file should
 be updated too.

>  README.licensing => Documentation/licensing.txt    |    0

 It would be nice to keep this file in the top-level directory.

>  tests/README => Documentation/tests.txt            |    0

 howto-tests.txt

>  Documentation/usage-howto.txt                      |   73 ++++++++++++++++++++

 howto-usage-function.txt

   and s/output/display/ in the file

 we also need howto-man-page.txt :-)


 I think we can split the README file:

    README  (basic info about project)

    Documentation/howto-compilation.txt 

 In the howto-compilation.txt file should be also a note about
 autogen.sh, static linking, klib and uClib and maybe some preferred
 compiler options, I use:
 
   -Wmissing-parameter-type -Wsign-compare -Wtype-limits -Wuninitialized \
   -Wunused-parameter -Wunused-but-set-parameter -fno-common

 We can also split README.devel to:

    Documentation/howto-compilation.txt (add extra section for
    developers (or SCM users) about about autotools).

    Documentation/howto-contribute.txt with info about "ideal
    patches", coding style.

    Documentation/source-code-management.txt


    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com

Re: [git pull] documentation directory

[Sami Kerola]

On Mon, Aug 8, 2011 at 13:46, Karel Zak <kzak@redhat.com> wrote:
> On Sat, Aug 06, 2011 at 07:57:53PM +0200, Sami Kerola wrote:
>> are available in the git repository at:
>> =A0 https://github.com/kerolasa/lelux-utiliteetit docs-dir
>>
>> discussion, and few rejects, before the Documentation/ is done to
>> upstream. For instance you might disagree with contents of
>> 00-about-docs.txt, and perhaps example.files/ should be deleted.
>
> =A0The 'Warning about content' in 00-about-docs.txt is too crazy :-)
> =A0Let's:

I thought you might say something like that.

> =A0- cleanup the files
>  - remove obsolete information

Done in new patch `docs: clean up old readme files'. The clean up
could be more aggressive. For instance the fdisk.txt sounds very 90's
and has only a limited amount of usable information. Perhaps the file
be simply removed, or should someone be asked to volunteer to clean up
all {c,s,}fdisk documentation & manual pages? By glance that looks
quite large task.

> =A0- move valid information to the man pages

Perhaps I lacked imagination what could be moved coz I found so
little. See hwclock change for details.

> =A0- add info about authors to the AUTHORS file

I went through everything in Documentation/* and notice there's more
in NEWS file. Should that be migrated as well?

> =A0I have updated the example.files/ in the master branch.

Noted.

>> =A0README.devel =3D> Documentation/README.devel =A0 =A0 =A0 =A0 | =A0 =
=A00
>
> =A0see below
>
>> =A0.../ReleaseNotes}/v2.13-ReleaseNotes =A0 =A0 =A0 =A0 =A0 =A0 =A0 | =
=A0 =A00
>
> =A0What about to rename the directory to releases/ ? The NEWS file should
> =A0be updated too.

Done.

>> =A0README.licensing =3D> Documentation/licensing.txt =A0 =A0| =A0 =A00
>
> =A0It would be nice to keep this file in the top-level directory.

Put back to root.

>> =A0tests/README =3D> Documentation/tests.txt =A0 =A0 =A0 =A0 =A0 =A0| =
=A0 =A00
>
> =A0howto-tests.txt

Renamed.

>> =A0Documentation/usage-howto.txt =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0=
 =A0| =A0 73 ++++++++++++++++++++
>
> =A0howto-usage-function.txt
>
> =A0 and s/output/display/ in the file

Renamed & the wording is checked.

> =A0we also need howto-man-page.txt :-)

Something done, comments are welcome.

> =A0I think we can split the README file:
>
> =A0 =A0README =A0(basic info about project)
>
> =A0 =A0Documentation/howto-compilation.txt
>
> =A0In the howto-compilation.txt file should be also a note about
> =A0autogen.sh, static linking, klib and uClib and maybe some preferred
> =A0compiler options, I use:
>
> =A0 -Wmissing-parameter-type -Wsign-compare -Wtype-limits -Wuninitialized=
 \
> =A0 -Wunused-parameter -Wunused-but-set-parameter -fno-common
>
> =A0We can also split README.devel to:
>
> =A0 =A0Documentation/howto-compilation.txt (add extra section for
> =A0 =A0developers (or SCM users) about about autotools).
>
> =A0 =A0Documentation/howto-contribute.txt with info about "ideal
> =A0 =A0patches", coding style.
>
> =A0 =A0Documentation/source-code-management.txt

This README.devel split was done as well.


The following changes since commit 344f73442d3a45db5927c049eef1ed8cf5d13934=
:

  ipcs: use unsigned type for uid/gid (2011-08-09 15:30:19 +0200)

are available in the git repository at:
  https://github.com/kerolasa/lelux-utiliteetit docs-dir

Sami Kerola (11):
      docs: remove README.clear
      docs: Documentation directory added
      docs: add usage() howto for contributors
      docs: tell what the Documentation/ is about
      docs: new file Documentation/howto-compilation.txt
      docs: new file Documentation/howto-contribute.txt
      docs: new file Documentation/source-code-management.txt
      docs: new file Documentation/howto-man-page.txt
      docs: copy contributors from legacy files to AUTHORS
      docs: clean up old readme files
      docs: move setuid information from reame to hwclock.8

--=20
=A0=A0 Sami Kerola
=A0=A0 http://www.iki.fi/kerolasa/

Re: [git pull] documentation directory

[Karel Zak]

On Sat, Aug 06, 2011 at 07:57:53PM +0200, Sami Kerola wrote:
> are available in the git repository at:
>   https://github.com/kerolasa/lelux-utiliteetit docs-dir

 I found a small problem... IMHO there should be some COPYING
 file in the libmount/ libblkid/ and libuuid/ directories.

 It's probably overkill to duplicate the text on all places (or in
 Documentation/licenses directory), so what about to add lib*/COPYING
 with:

        This library is free software; you can redistribute it and/or
        modify it under the terms of the GNU Lesser General Public
        License as published by the Free Software Foundation; either
        version 2.1 of the License, or (at your option) any later version.

        The complete text of the license is available at the 
        Documentation/licenses/COPYING.LGPL file.


 and add one Documentation/licenses/COPYING.LGPL file for all libraries.

 I'm not sure if we need the LICENSE.pg file, the same text is at the
 begin of the pg.c.

    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com

Re: [git pull] documentation directory

[Sami Kerola]

On Tue, Aug 30, 2011 at 10:43, Karel Zak <kzak@redhat.com> wrote:
> On Sat, Aug 06, 2011 at 07:57:53PM +0200, Sami Kerola wrote:
>> are available in the git repository at:
>> =A0 https://github.com/kerolasa/lelux-utiliteetit docs-dir
>
> =A0I found a small problem... IMHO there should be some COPYING
> =A0file in the libmount/ libblkid/ and libuuid/ directories.
>
> =A0It's probably overkill to duplicate the text on all places (or in
> =A0Documentation/licenses directory), so what about to add lib*/COPYING
> =A0with:
>
> =A0 =A0 =A0 =A0This library is free software; you can redistribute it and=
/or
> =A0 =A0 =A0 =A0modify it under the terms of the GNU Lesser General Public
> =A0 =A0 =A0 =A0License as published by the Free Software Foundation; eith=
er
> =A0 =A0 =A0 =A0version 2.1 of the License, or (at your option) any later =
version.
>
> =A0 =A0 =A0 =A0The complete text of the license is available at the
> =A0 =A0 =A0 =A0Documentation/licenses/COPYING.LGPL file.
>
> =A0and add one Documentation/licenses/COPYING.LGPL file for all libraries=
.

Done nearly that way. If I did not see wrong the libuuid uses Modified
BSD License. Secondly instead of writing LGPL I prefer to using v2.1
in file name.

> =A0I'm not sure if we need the LICENSE.pg file, the same text is at the
> =A0begin of the pg.c.

Yup, that seems unnecessary. The file is removed.

Is there anything else which should be changed?

--=20
=A0=A0 Sami Kerola
=A0=A0 http://www.iki.fi/kerolasa/

Re: [git pull] documentation directory

[Karel Zak]

On Tue, Aug 30, 2011 at 08:18:01PM +0200, Sami Kerola wrote:
> On Tue, Aug 30, 2011 at 10:43, Karel Zak <kzak@redhat.com> wrote:
> > On Sat, Aug 06, 2011 at 07:57:53PM +0200, Sami Kerola wrote:
> >> are available in the git repository at:
> >>   https://github.com/kerolasa/lelux-utiliteetit docs-dir

 Merged.

> Done nearly that way. If I did not see wrong the libuuid uses Modified
> BSD License. Secondly instead of writing LGPL I prefer to using v2.1
> in file name.

 It's not GPL but LGPL, this abbreviation for the GNU Lesser General
 Public License is pretty common. I have renamed the file to .LGPLv2.1

    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com

Re: [git pull] documentation directory

[Karel Zak]

On Wed, Aug 31, 2011 at 11:17:07AM +0200, Karel Zak wrote:
> On Tue, Aug 30, 2011 at 08:18:01PM +0200, Sami Kerola wrote:
> > On Tue, Aug 30, 2011 at 10:43, Karel Zak <kzak@redhat.com> wrote:
> > > On Sat, Aug 06, 2011 at 07:57:53PM +0200, Sami Kerola wrote:
> > >> are available in the git repository at:
> > >>   https://github.com/kerolasa/lelux-utiliteetit docs-dir
> 
>  Merged.

 Hmm... it seems the server with git repos at kernel.org is down right
 now, I'll push it later.

    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com