]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - README
Merge branch 'PR/libmount-exec-errors' of github.com:karelzak/util-linux-work
[thirdparty/util-linux.git] / README
diff --git a/README b/README
index 30e99d464ef3fd382605c3e31e0f87284331664f..db538f02a74b0e6a4e49ee87f4c575e3784c2bb9 100644 (file)
--- a/README
+++ b/README
 
-                                  util-linux
+                                 util-linux
 
-              util-linux is a random collection of Linux utilities
+               util-linux is a random collection of Linux utilities
 
-     Note that in years 2006-2010 this project used the name "util-linux-ng".
+     Note: for the years 2006-2010 this project was named "util-linux-ng".
 
-WEB PAGE:
-
-     http://kernel.org/~kzak/util-linux/
+COMPILE & INSTALL:
 
+      See Documentation/howto-compilation.txt.
 
 MAILING LIST:
 
-      E-MAIL: util-linux@vger.kernel.org
-      URL:    http://vger.kernel.org/vger-lists.html#util-linux
+      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
 
-DOWNLOAD:
+IRC CHANNEL:
 
-      ftp://ftp.kernel.org/pub/linux/utils/util-linux/
+      #util-linux at libera.chat:
 
+      irc://irc.libera.chat/util-linux
 
-SOURCE CODE:
+      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.
 
-      Web interface:
-          http://git.kernel.org/?p=utils/util-linux/util-linux.git
-      Checkout:
-          git clone git://git.kernel.org/pub/scm/utils/util-linux/util-linux.git util-linux
+BUG REPORTING:
 
-NLS (PO TRANSLATIONS):
+      E-MAIL: util-linux@vger.kernel.org
+      Web:    https://github.com/util-linux/util-linux/issues
 
-      PO files are maintained by:
-          http://translationproject.org/domain/util-linux-ng.html
+      Bug reports with sensitive or private information: Karel Zak <kzak@redhat.com>
 
-NEUTRALITY:
+      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.
 
-      The stuff in util-linux should be rather distribution-neutral.
-      No RPMs/DEBs/... are provided - get yours from your distributor.
+NLS (PO TRANSLATIONS):
 
+      PO files are maintained by:
+         https://translationproject.org/domain/util-linux.html
 
 VERSION SCHEMA:
 
       Standard releases:
-
-          <major>.<minor>[.<maint>[.<bugfix>]]
-
-             major = fatal and deep changes
-             minor = typical release with new fetures
-             maint = maintenance releases; bug fixes only
-             bugfix = unplanned releases for critical/security bugs
+         <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>
 
-         <major>.<minor>-rc<N>
-
-
-COMPILATION:
-
-      See the INSTALL file for more details.
-
-      Notes:
-            * use SUID_CFLAGS and SUID_LDFLAGS when you want to define special
-              compiler options for typical suid programs, for example:
-
-                  ./configure SUID_CFLAGS="-fpie" SUID_LDFLAGS="-pie"
-
-              This feature is currently supported for chfn, chsh, newgrp,
-              write, mount, and umount.
-
-
-STATIC LINKING:
-
-      Use --enable-static-programs[=LIST] configure option when you want to use
-      statically linked programs.
-
-      Note, mount(8) uses get{pw,gr}nam() and getpwuid() functions for
-      translation from username and groupname to UID and GID. These functions
-      could be implemented by dynamically loaded independent modules (NSS) in
-      your libc (e.g. glibc). These modules are not statically linked to
-      mount(8) and mount.static is still using dlopen() like dynamically
-      linked version.
-
-      The translation won't work in environment where NSS modules are
-      not installed.
-
-      For example normal system (NSS modules are available):
-
-              # ./mount.static -v -f -n -ouid=kzak /mnt/foo
-              LABEL=/mnt/foo on /mnt/foo type vfat (rw,uid=500)
-                                                       ^^^^^^^
-      and without NSS modules:
-
-              # chroot . ./mount.static -v -f -n -ouid=kzak /mnt/win
-              LABEL=/mnt/win on /mnt/win type vfat (rw,uid=kzak)
-                                                       ^^^^^^^^
+SOURCE CODE:
 
+ Download archive:
+         https://www.kernel.org/pub/linux/utils/util-linux/
+
+ See also:
+     Documentation/howto-contribute.txt
+     Documentation/howto-build-sys.txt
+     Documentation/howto-pull-request.txt
+
+ 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 https://github.com/util-linux/util-linux.git
+
+    Web interfaces:
+         https://git.kernel.org/cgit/utils/util-linux/util-linux.git
+         https://github.com/util-linux/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:
+          - Continuously developed, no feature freeze or translation freezes.
+          - Day-to-day status is: 'it works for me'. This means that its
+            normal state is useful but not well tested.
+
+         Stable Branches:
+          - Public releases.
+          - Branch name: stable/v<major>.<minor>.
+          - Created from the 'master' branch.
+          - The release candidates and final release are always based
+             on the stable 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'
+          - v<version> tag is created in the stable branch for every release.
+          - v<version>-devel is created in the master branch to start work on the next release.
+          - All tags are signed by the maintainer's PGP key.
+
+
+WORKFLOW EXAMPLE:
+
+    Development                     Releases
+    (Master Branch)                 (Stable/vX.Y Branch)
+
+    - Sync latest translations
+      from translationproject.org
+    - Tag v<X.Y+1>-devel            - Fork from master to stable/v<X.Y> branch
+                                      - Code stabilization
+                                    - RC1 (Tag v<X.Y>-rc1)
+                                      - Backport bug fixes
+                                    - RC2 (Tag v<X.Y>-rc2)
+                                      - po/ and po-man/ translations available on
+                                        translationproject.org/
+                                      - Wait 7-17 days for translators
+                                      - Sync latest translations
+                                      - Backport bug fixes
+                                    - Final release v<X.Y> (Tag v<X.Y>)
+                                      ...
+                                    - Release v<X.Y>.1
+                                      ...
+                                    - Release v<X.Y>.2