On Mon, Aug 8, 2011 at 13:46, Karel Zak <kzak@xxxxxxxxxx> 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 >> >> 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: I thought you might say something like that. > - 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. > - 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. > - 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? > I have updated the example.files/ in the master branch. Noted. >> 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. Done. >> README.licensing => Documentation/licensing.txt | 0 > > It would be nice to keep this file in the top-level directory. Put back to root. >> tests/README => Documentation/tests.txt | 0 > > howto-tests.txt Renamed. >> Documentation/usage-howto.txt | 73 ++++++++++++++++++++ > > howto-usage-function.txt > > and s/output/display/ in the file Renamed & the wording is checked. > we also need howto-man-page.txt :-) Something done, comments are welcome. > 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 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 -- Sami Kerola http://www.iki.fi/kerolasa/ -- To unsubscribe from this list: send the line "unsubscribe util-linux" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
