Commit Graph

392 Commits

Author SHA1 Message Date
Petr Uzel 89c6bb4dad docs: trivial documentation fixes and improvements
Signed-off-by: Petr Uzel <petr.uzel@suse.cz>
2012-02-22 11:52:07 +01:00
Karel Zak bdc1764e23 docs: add note about losetup to TODO
Signed-off-by: Karel Zak <kzak@redhat.com>
2012-02-21 20:31:40 +01:00
Karel Zak 838b8e0f71 docs: add note about fdisk to TODO
Signed-off-by: Karel Zak <kzak@redhat.com>
2012-02-21 18:59:50 +01:00
Karel Zak 983ddee513 docs: update v2.21-ReleaseNotes
Signed-off-by: Karel Zak <kzak@redhat.com>
2012-02-06 18:27:05 +01:00
Karel Zak 11d92f3425 docs: update TODO
Signed-off-by: Karel Zak <kzak@redhat.com>
2012-01-30 14:55:58 +01:00
Karel Zak b82590ad46 blkid: move cache to /run on new systems
Why?

 * read-only root

 * /etc is pretty bad place for caches

 * all is usually cached by udev in /dev/disk/by-* and libblkid
   is able to use these symlinks

 * boot persistent cache is attractive for very small subset of
   Linux machines (and they already need extra udev tunning otherwise
   udev will probe all block devices during boot)

 * the default is possible to override in /etc/blkid.conf

The systems without /run directory will not be affected by this
change.

Signed-off-by: Karel Zak <kzak@redhat.com>
2012-01-25 13:20:37 +01:00
Karel Zak a6ec840a17 docs: add v2.21 ReleaseNotes
Signed-off-by: Karel Zak <kzak@redhat.com>
2012-01-18 14:20:09 +01:00
Karel Zak 0b359bcdfd docs: add info about virt-what to TODO
Signed-off-by: Karel Zak <kzak@redhat.com>
2012-01-10 16:48:37 +01:00
Karel Zak aca9b5a6fb docs: add hwclock -c to TODO file
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-12-09 14:08:02 +01:00
Karel Zak 21fd9cb0d7 docs: add x-mount-mkdir to TODO file
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-29 14:57:28 +01:00
Karel Zak 1c50a7cd94 docs: update TODO file
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-11 12:58:59 +01:00
Karel Zak 614601052e docs: refresh TODO file
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-08 16:38:56 +01:00
Karel Zak 790a26b945 docs: add note about config-gen purpose
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-07 11:31:47 +01:00
Karel Zak f2278b63b8 docs: refresh TODO file
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-07 11:18:09 +01:00
Karel Zak 3db444cbff docs: add notes about tools/config-gen
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-04 20:59:52 +01:00
Karel Zak ff0cb84ddb build-sys: cleanup BUILD_LOGIN_UTILS
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-03 12:32:50 +01:00
Karel Zak 30f9fbb488 docs: add note about BUILD_* macros
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-03 12:32:49 +01:00
Karel Zak aa59480526 docs: add howto-build-sys.txt
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-11-03 12:32:49 +01:00
Davidlohr Bueso fe208f9e78 docs: update TODO file
Signed-off-by: Davidlohr Bueso <dave@gnu.org>
2011-11-02 16:24:43 +01:00
Karel Zak 66388d95fc docs: update TODO
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-10-11 16:41:34 +02:00
Karel Zak fd96508a27 docs: add prlimit to the TODO file
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-09-30 12:40:44 +02:00
Petr Uzel 960cf5737e misc: use %m in format string instead of %s and strerror(errno)
Signed-off-by: Petr Uzel <petr.uzel@suse.cz>
2011-09-27 15:46:07 +02:00
Petr Uzel 587aa6fca1 docs: update TODO
TODO items already done by Sami Kerola

Signed-off-by: Petr Uzel <petr.uzel@suse.cz>
2011-09-27 15:37:29 +02:00
Sami Kerola 0c12134874 docs: add non-return function and if shorthand tips
Non-return functions should not be combined with `else' clause.

The if shorthands `var = e ? t : f;' need to fit to single line,
and if that does not look good use normal "if else" syntax.

Both tips are mentioned in email bellow.

http://www.spinics.net/lists/util-linux-ng/msg05152.html

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-09-17 15:07:52 +02:00
Sami Kerola 6f162034d0 build-sys: fixes to USAGE_* macros
The USAGE_BEGIN_TAIL is removed as unnecessary.

In between command specific options and --help & --version
USAGE_SEPARATOR is inserted. For now the separator is empty line.

The USAGE_MAN_TAIL is changed to take an argument.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-09-17 15:07:52 +02:00
Karel Zak da9629917d docs: use .LGPL extension for file with GNU Lesser License
Signed-off-by: Karel Zak <kzak@redhat.com>
2011-08-31 11:12:17 +02:00
Karel Zak fa25f2289c Merge branch 'docs-dir' of https://github.com/kerolasa/lelux-utiliteetit
* 'docs-dir' of https://github.com/kerolasa/lelux-utiliteetit:
  docs: remove duplicated text
  docs: require kernel support before accepting use of it
  docs: note about independent super block structs
  docs: add libmount & libblkid debug instructions
  Documentation: add debugging doc
  arch: start using arch as a usage() example
  docs: new file Documentation/release-schedule.txt
  docs: move setuid information from reame to hwclock.8
  docs: clean up old readme files
  docs: copy contributors from legacy files to AUTHORS
  docs: new file Documentation/howto-man-page.txt
  docs: new file Documentation/source-code-management.txt
  docs: new file Documentation/howto-contribute.txt
  docs: new file Documentation/howto-compilation.txt
  docs: tell what the Documentation/ is about
  docs: add usage() howto for contributors
  docs: Documentation directory added
  docs: remove README.clear
2011-08-31 11:04:15 +02:00
Sami Kerola ce0efc40a1 docs: remove duplicated text
Duplicate text is dealt by referring to license files. The `pg'
command does not need separated license file because the source
file has same text at top of it.

http://www.spinics.net/lists/util-linux-ng/msg05069.html

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-30 19:50:34 +02:00
Sami Kerola 464e11b8f5 docs: require kernel support before accepting use of it
http://www.spinics.net/lists/kernel/msg1228993.html

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-28 10:50:42 +02:00
Sami Kerola c0dcd7d0b8 docs: note about independent super block structs
It's normal that we use our own (on kernel independent) copy of
FS superbloks. -- K. Zak

http://www.spinics.net/lists/util-linux-ng/msg04812.html

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-28 10:50:42 +02:00
Sami Kerola 7ec51ba998 docs: add libmount & libblkid debug instructions
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-28 10:50:42 +02:00
Davidlohr Bueso 2e88e3c6cc Documentation: add debugging doc
Layout the base for tips on debugging util-linux programs/wrappers.

[kerolasa@iki.fi:
	- rename file README.debug -> howto-debug.txt
	- wrap over 80 chars wide lines
	- change example commands to be relative to util-linux root
	- indent command examples
]

Signed-off-by: Davidlohr Bueso <dave@gnu.org>
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-28 10:50:42 +02:00
Sami Kerola b6459b5158 docs: new file Documentation/release-schedule.txt
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:21 +02:00
Sami Kerola a6ccf39bf8 docs: move setuid information from reame to hwclock.8
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:21 +02:00
Sami Kerola 1a06cbf4f6 docs: clean up old readme files
Removal of information which is simply wrong.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:21 +02:00
Sami Kerola 05620dd47e docs: new file Documentation/howto-man-page.txt
The howto-man-page.txt is an example of good groff syntax and
document about man page at the same time.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:21 +02:00
Sami Kerola bbe204588e docs: new file Documentation/source-code-management.txt
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:21 +02:00
Sami Kerola 90a1baf6cb docs: new file Documentation/howto-contribute.txt
The file contens are mostly from former README.devel.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:20 +02:00
Sami Kerola 22a3b8c9bd docs: new file Documentation/howto-compilation.txt
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:20 +02:00
Sami Kerola 28a6074b4c docs: tell what the Documentation/ is about
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:20 +02:00
Sami Kerola e1271f8ddc docs: add usage() howto for contributors
Style instructions to usage() writers. Discussion about this;
http://www.spinics.net/lists/util-linux-ng/index.html#04983

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:13 +02:00
Sami Kerola f98d4f766e docs: Documentation directory added
Move readme, licence, change log, relese notes and other
supplementary files to a Documentation directory. This commit
does not change contents of any other but few Makefile.am files.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-12 20:19:52 +02:00