Go to file
Michael Kerrisk (man-pages) 380fd9aa95 Manual pages: order ENVIRONMENT / FILES / CONFORMING TO consistently
There is value in ensuring that manual page sections use consistently
named sections, as far as possible, and also that sections have a
consistent order within manual pages. This is one of a series of patches
to place manual page sections in a consistent order.

In this patch, we ensure that the ENVIRONMENT, FILES, and CONFORMING TO
sections are always placed toward the end of the page, just above NOTES.

One page is not fixed by this patch: term-utils/agetty.8. This page
is a mess of unusual section names, and probably requires an individual
edit.

Testing that no gross editing mistake (causing accidental loss or addition
of text) was performed as follows:

    $ cat $(grep '\.SH' -l $(find . -name '*.[1-9]') |sort) | sort > a
    [Apply patch]
    $ cat $(grep '\.SH' -l $(find . -name '*.[1-9]') |sort) | sort > b
    $ diff a b
    $ echo $?
    0

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-05-22 10:25:52 +02:00
Documentation cal: Remove todo 2020-05-11 17:41:54 +02:00
bash-completion cal: Add column mode 2020-05-11 17:27:06 +02:00
config build-sys: gtkdoc-fixxref v1.27 requires module option 2018-02-01 13:23:40 +01:00
disk-utils Manual pages: order ENVIRONMENT / FILES / CONFORMING TO consistently 2020-05-22 10:25:52 +02:00
include lsblk: Ignore hidden devices 2020-05-14 15:48:26 +02:00
lib Manual pages: order ENVIRONMENT / FILES / CONFORMING TO consistently 2020-05-22 10:25:52 +02:00
libblkid Manual pages: Standardize on AUTHORS as section title 2020-05-20 12:56:12 +02:00
libfdisk libfdisk: (dos) fix default partition start 2020-05-21 15:37:59 +02:00
libmount Add to the list of pseudo-filesystem types 2020-05-20 20:28:01 +02:00
libsmartcols libsmartcols: don't calculate with encoding on scols_table_enable_noencoding() 2020-04-22 12:24:33 +02:00
libuuid Manual pages: order AUTHORS / COPYRIGHT / SEE ALSO / AVAILABILITY consistently 2020-05-22 10:25:49 +02:00
login-utils Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently 2020-05-22 10:25:50 +02:00
m4 build-sys: add missing NR underscore to UL_CHECK_SYSCALL() 2019-11-25 20:33:05 +00:00
misc-utils Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently 2020-05-22 10:25:50 +02:00
po po: update uk.po (from translationproject.org) 2020-01-22 20:52:11 +02:00
schedutils Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently 2020-05-22 10:25:50 +02:00
sys-utils Manual pages: order ENVIRONMENT / FILES / CONFORMING TO consistently 2020-05-22 10:25:52 +02:00
term-utils Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently 2020-05-22 10:25:50 +02:00
tests cal: Add test, all are checked against ncal 2020-05-11 17:41:54 +02:00
text-utils Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently 2020-05-22 10:25:50 +02:00
tools build-sys: add --with-cryptsetup to config-gen.d/all.conf 2019-12-05 14:57:50 +01:00
.editorconfig add .editorconfig 2016-01-25 00:12:14 +01:00
.gitignore lsirq: add new command 2020-03-06 16:21:10 +01:00
.travis-functions.sh travis: fix sudo command line 2019-12-16 14:29:33 +01:00
.travis.yml docs: add info about branches; update travis.yml 2018-10-24 13:02:59 +02:00
AUTHORS docs: update AUTHORS file 2020-01-21 11:07:27 +01:00
COPYING docs: corrections to FSF license files, and postal address 2012-02-24 14:13:35 +01:00
ChangeLog docs: Correct ChangeLog URL to history log. 2020-05-11 09:48:43 +02:00
Makefile.am getopt: use examples installation directory in man page 2020-02-15 15:24:01 +00:00
NEWS build-sys: release++ (v2.35) 2020-01-21 11:15:21 +01:00
README docs: add link to mail list archive 2018-12-17 10:16:22 +01:00
README.licensing docs: add GPLv3 text 2019-11-08 11:10:54 +01:00
autogen.sh build-sys: improve bison version detection 2018-04-30 09:43:32 +02:00
configure.ac more: use libmagic to identify binary files 2020-05-12 10:22:09 +02:00
util-linux.doap docs: replace FTP by HTTPS in kernel.org URLs 2016-12-19 11:22:26 +01:00

README

				  util-linux

		util-linux is a random collection of Linux utilities

     Note: for the years 2006-2010 this project was named "util-linux-ng".

MAILING LIST:

      E-MAIL:  util-linux@vger.kernel.org
      URL:     http://vger.kernel.org/vger-lists.html#util-linux
      ARCHIVE: https://lore.kernel.org/util-linux/

      The mailing list will reject email messages that contain:
       - more than 100K characters
       - html
       - spam phrases/keywords
      See: http://vger.kernel.org/majordomo-info.html#taboo

IRC CHANNEL:

      #util-linux at freenode.net:

      irc://chat.freenode.net/util-linux

      The IRC channel and Mailing list are for developers and project
      maintainers. For end users it is recommended to utilize the
      distribution's support system.

BUG REPORTING:

      E-MAIL: util-linux@vger.kernel.org
      Web:    https://github.com/karelzak/util-linux/issues

      This project has no resources to provide support for distribution specific
      issues. For end users it is recommended to utilize the distribution's
      support system.

NLS (PO TRANSLATIONS):

      PO files are maintained by:
	  http://translationproject.org/domain/util-linux.html

VERSION SCHEMA:

      Standard releases:
	  <major>.<minor>[.<maint>]
	     major = fatal and deep changes
	     minor = typical release with new features
	     maint = maintenance releases; bug fixes only

      Development releases:
	 <major>.<minor>-rc<N>

SOURCE CODE:

 Download archive:
	  https://www.kernel.org/pub/linux/utils/util-linux/

 SCM (Source Code Management) Repository:

    Primary repository:
	  git clone git://git.kernel.org/pub/scm/utils/util-linux/util-linux.git

    Backup repository:
	  git clone git://github.com/karelzak/util-linux.git

    Web interfaces:
	  http://git.kernel.org/cgit/utils/util-linux/util-linux.git
	  https://github.com/karelzak/util-linux

      Note: the GitHub repository may contain temporary development branches too.

      The kernel.org repository contains master (current development) and stable/*
      (maintenance) branches only. All master or stable/* changes are always pushed
      to both repositories at the same time.

    Repository Branches: 'git branch -a'
	  master branch
	   - current development
	   - the source for stable releases when deemed ready.
	   - day-to-day status is: 'it works for me'. This means that its
	     normal state is useful but not well tested.
	   - long-term development or invasive changes in active development are
	     forked into separate 'topic' branches from the tip of 'master'.

	  stable/ branches
	   - public releases
	   - branch name: stable/v<major>.<minor>.
	   - created from the 'master' branch after two or more release
	     candidates and the final public release. This means that the stable
	     releases are committed, tagged, and reachable in 'master'.
	   - these branches then become forked development branches. This means
	     that any changes made to them diverge from the 'master' branch.
	   - maintenance releases are part of, and belong to, their respective
	     stable branch. As such, they are tags(<major>.<minor>.<maint>) and
	     not branches of their own. They are not part of, visible in, or
	     have anything to do with the 'master' development branch. In git
	     terminology: maintenance releases are not reachable from 'master'.
	   - when initially cloned (as with the 'git clone' command given above)
	     these branches are created as 'remote tracking branches' and are
	     only visible by using the -a or -r options to 'git branch'. To
	     create a local branch use the desired tag with this command:
	     'git checkout -b v2.29.2 v2.29.2'

    Tags: 'git tag'
	   - a new tag object is created for every release.
	   - tag name: v<version>.
	   - all tags are signed by the maintainer's PGP key.

    Known Bugs:
	- don't use tag v2.13.1 (created and published by mistake),
	  use v2.13.1-REAL instead.

WORKFLOW EXAMPLE:

 1) development (branch: <master>)

 2) master release (tags: v2.29-rc1, v2.29-rc2, v2.29, branch: <master>)

 3) development (work on v2.30, branch: <master>)

 4) fork -- create a new branch <stable/v2.29> based on tag v2.29

     4a) new patches or cherry-pick patches from <master> (branch: <stable/v2.29>)

     4b) stable release (tag: v2.29.1, branch: <stable/v2.29>)

     4c) more patches; another release (tag: v2.29.2, branch: <stable/v2.29>)

 5) master release v2.30 (branch: <master>)
    ...

where 3) and 4) happen simultaneously.