README

   1
   2                                   util-linux
   3
   4                 util-linux is a random collection of Linux utilities
   5
   6      Note: for the years 2006-2010 this project was named "util-linux-ng".
   7
   8 COMPILE & INSTALL:
   9
  10       See Documentation/howto-compilation.txt.
  11
  12 MAILING LIST:
  13
  14       E-MAIL:  util-linux@vger.kernel.org
  15       URL:     http://vger.kernel.org/vger-lists.html#util-linux
  16       ARCHIVE: https://lore.kernel.org/util-linux/
  17
  18       The mailing list will reject email messages that contain:
  19        - more than 100K characters
  20        - html
  21        - spam phrases/keywords
  22       See: http://vger.kernel.org/majordomo-info.html#taboo
  23
  24 IRC CHANNEL:
  25
  26       #util-linux at libera.chat:
  27
  28       irc://irc.libera.chat/util-linux
  29
  30       The IRC channel and Mailing list are for developers and project
  31       maintainers. For end users it is recommended to utilize the
  32       distribution's support system.
  33
  34 BUG REPORTING:
  35
  36       E-MAIL: util-linux@vger.kernel.org
  37       Web:    https://github.com/util-linux/util-linux/issues
  38
  39       Bug reports with sensitive or private information: Karel Zak <kzak@redhat.com>
  40
  41       This project has no resources to provide support for distribution specific
  42       issues. For end users it is recommended to utilize the distribution's
  43       support system.
  44
  45 NLS (PO TRANSLATIONS):
  46
  47       PO files are maintained by:
  48           https://translationproject.org/domain/util-linux.html
  49
  50 VERSION SCHEMA:
  51
  52       Standard releases:
  53           <major>.<minor>[.<maint>]
  54              major = fatal and deep changes
  55              minor = typical release with new features
  56              maint = maintenance releases; bug fixes only
  57
  58       Development releases:
  59          <major>.<minor>-rc<N>
  60
  61 SOURCE CODE:
  62
  63  Download archive:
  64           https://www.kernel.org/pub/linux/utils/util-linux/
  65
  66  See also:
  67      Documentation/howto-contribute.txt
  68      Documentation/howto-build-sys.txt
  69      Documentation/howto-pull-request.txt
  70
  71  SCM (Source Code Management) Repository:
  72
  73     Primary repository:
  74           git clone git://git.kernel.org/pub/scm/utils/util-linux/util-linux.git
  75
  76     Backup repository:
  77           git clone https://github.com/util-linux/util-linux.git
  78
  79     Web interfaces:
  80           https://git.kernel.org/cgit/utils/util-linux/util-linux.git
  81           https://github.com/util-linux/util-linux
  82
  83       Note: the GitHub repository may contain temporary development branches too.
  84
  85       The kernel.org repository contains master (current development) and stable/*
  86       (maintenance) branches only. All master or stable/* changes are always pushed
  87       to both repositories at the same time.
  88
  89     Repository Branches: 'git branch -a'
  90           Master Branch:
  91            - Continuously developed, no feature freeze or translation freezes.
  92            - Day-to-day status is: 'it works for me'. This means that its
  93              normal state is useful but not well tested.
  94
  95           Stable Branches:
  96            - Public releases.
  97            - Branch name: stable/v<major>.<minor>.
  98            - Created from the 'master' branch.
  99            - The release candidates and final release are always based
 100              on the stable branch.
 101            - Maintenance releases are part of, and belong to, their respective
 102              stable branch. As such, they are tags(<major>.<minor>.<maint>) and
 103              not branches of their own. They are not part of, visible in, or
 104              have anything to do with the 'master' development branch. In git
 105              terminology: maintenance releases are not reachable from 'master'.
 106            - When initially cloned (as with the 'git clone' command given above),
 107              these branches are created as 'remote tracking branches' and are
 108              only visible by using the -a or -r options to 'git branch'. To
 109              create a local branch, use the desired tag with this command:
 110              'git checkout -b v2.29.2 v2.29.2'
 111
 112     Tags: 'git tag'
 113            - v<version> tag is created in the stable branch for every release.
 114            - v<version>-devel is created in the master branch to start work on the next release.
 115            - All tags are signed by the maintainer's PGP key.
 116
 117
 118 WORKFLOW EXAMPLE:
 119
 120     Development                     Releases
 121     (Master Branch)                 (Stable/vX.Y Branch)
 122
 123     - Sync latest translations
 124       from translationproject.org
 125     - Tag v<X.Y+1>-devel            - Fork from master to stable/v<X.Y> branch
 126                                       - Code stabilization
 127                                     - RC1 (Tag v<X.Y>-rc1)
 128                                       - Backport bug fixes
 129                                     - RC2 (Tag v<X.Y>-rc2)
 130                                       - po/ and po-man/ translations available on
 131                                         translationproject.org/
 132                                       - Wait 7-17 days for translators
 133                                       - Sync latest translations
 134                                       - Backport bug fixes
 135                                     - Final release v<X.Y> (Tag v<X.Y>)
 136                                       ...
 137                                     - Release v<X.Y>.1
 138                                       ...
 139                                     - Release v<X.Y>.2
 140