diff options
author | Alejandro Colomar <alx@kernel.org> | 2023-07-08 20:28:14 +0200 |
---|---|---|
committer | Alejandro Colomar <alx@kernel.org> | 2023-07-08 20:28:14 +0200 |
commit | 315cc123cdba79098bf1ab7cc7a103061d9383ed (patch) | |
tree | dd900d7ab357694e7e08d23e309b5a4b52bc20a8 /RELEASE | |
parent | 1aa2f96bfbc0090c5edf094ac9a48c717e5776e8 (diff) |
CONTRIBUTING, INSTALL, README, RELEASE: Reflow to 72 columns
This makes it easier to quote in emails.
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'RELEASE')
-rw-r--r-- | RELEASE | 117 |
1 files changed, 60 insertions, 57 deletions
@@ -5,15 +5,15 @@ Synopsis Change log, git tag, tarball, LSM, email, and push. Description - This are the instructions to release a new official version of the - project. However, these should also be useful for those who simply - want to package a random commit (this is done for example by Gentoo). - For packaging a random commit without an official release, you only - need step (4) "Tarball". + This are the instructions to release a new official version of + the project. However, these should also be useful for those who + simply want to package a random commit (this is done for example + by Gentoo). For packaging a random commit without an official + release, you only need step (4) "Tarball". Dependencies - The following list of dependencies states what the build system (the - makefiles) need to perform the relevant (dist) targets: + The following list of dependencies states what the build system + (the makefiles) need to perform the relevant (dist) targets: - echo(1) - expr(1) @@ -30,8 +30,8 @@ Description - xargs(1) - xz(1) - Apart from that, the following commands are also needed for other tasks - shown below: + Apart from that, the following commands are also needed for other + tasks shown below: - gpg(1) - kup(1) @@ -46,20 +46,20 @@ Description (2) Changes - Fill the <Changes> file. For that you can check older commits, - like d4e80a7748 "Changes: Ready for 6.01". It needs manual - intervention, but in that commit log you can check a few commands - that will help. + Fill the <Changes> file. For that you can check older + commits, like d4e80a7748 "Changes: Ready for 6.01". It + needs manual intervention, but in that commit log you can + check a few commands that will help. - Remember to change the version number, the date, and the location. - - Remove any headers not used for a specific release (usually\ - happens with "New and changed links"). + - Remove any headers not used for a specific release + (usually happens with "New and changed links"). - The structure is a bit freestyle, but keep it organized. - man-pages-6.00 was a huge release, so it might help to check it: - 51228378bec7 "Changes: Ready for 6.00". + man-pages-6.00 was a huge release, so it might help to + check it: 51228378bec7 "Changes: Ready for 6.00". - Commit: @@ -69,10 +69,10 @@ Description (3) Tag Create a signed tag. The tag message should note the most - important changes in the version being released, since it will be - read by users and packagers. It should include any information - that is especially relevant for them. Check old tags such as - 'man-pages-6.00' or 'man-pages-6.01'. + important changes in the version being released, since it + will be read by users and packagers. It should include any + information that is especially relevant for them. Check old + tags such as 'man-pages-6.00' or 'man-pages-6.01'. - Tag: @@ -81,24 +81,25 @@ Description (4) Tarball Creating the tarball will embed in the manual pages both the - version number, and the date of last modification (in the git - repository, the pages have placeholders for the date and the - version). + version number, and the date of last modification (in the + git repository, the pages have placeholders for the date and + the version). - You need to create a set of tarballs, sign the .tar archive, and - upload the compressed tarballs to <kernel.org>. + You need to create a set of tarballs, sign the .tar archive, + and upload the compressed tarballs to <kernel.org>. In case you're creating a tarball for distributing a random - commit, it might be interesting to tweak a few parameters; check - the variables available at <share/mk/dist.mk>, and any makefiles - included by that one. See the "Versions" section below. + commit, it might be interesting to tweak a few parameters; + check the variables available at <share/mk/dist.mk>, and any + makefiles included by that one. See the "Versions" section + below. - Create the tarball: $ make -Bj4 dist - Alternatively, you may want to only create a specific kind of - tarball with one of the following targets: + Alternatively, you may want to only create a specific + kind of tarball with one of the following targets: $ make -Bj4 dist-tar dist-xz dist-gz @@ -129,27 +130,28 @@ Description $ git add lsm $ git commit -sm "lsm: Released ${new}" - - Send (email) the lsm file to <lsm@qqx.org> with the subject - "add". + - Send (email) the lsm file to <lsm@qqx.org> with the + subject "add". (6) Email Send an announce email to linux-man, LKML, libc-alpha, and - possibly others that might be interested in the release, such as - distribution maintainers, or those who have contributed to the - release. + possibly others that might be interested in the release, + such as distribution maintainers, or those who have + contributed to the release. The email should contain a mix of the git tag message, the - contents of Changes, and anything else that might be relevant. - Check old emails such as + contents of Changes, and anything else that might be + relevant. Check old emails such as <https://lore.kernel.org/linux-man/4ba6c215-6d28-1769-52d3-04941b962ff3@kernel.org/T/#u>. - The subject of the email should be "man-pages-${new} released". + The subject of the email should be + "man-pages-${new} released". (7) Changes.old - Move the contents of <Changes> to <Changes.old>, and prepare for - the next release. + Move the contents of <Changes> to <Changes.old>, and prepare + for the next release. - Copy contents of <Changes> to <Changes.old>: @@ -164,12 +166,12 @@ Description $ git add Changes Changes.old $ git commit -sm \ - "Start of man-pages-NEXT: Move Changes to Changes.old" + "Start of man-pages-NEXT: Move Changes to Changes.old" (8) Push - You've finished. When you confirm it's good, push to the git - repository. + You've finished. When you confirm it's good, push to the + git repository. - Push: @@ -183,28 +185,29 @@ Files Change log. Includes most relevant changes. Makefile, share/mk/dist.mk, share/mk/version.mk - Main makefiles used for releasing (however, others may also be used by - inclusion). + Main makefiles used for releasing (however, others may also be + used by inclusion). lsm Linux software map. See also <https://lsm.qqx.org/>. .tmp/man-pages-<version>.tar{,.xz,.gz} Generated tarballs. You can generate all with 'make -B dist', or - generate only some of them, with 'make -B dist-tar', 'make -B dist-xz', - or 'make -B dist-gz'. + generate only some of them, with 'make -B dist-tar', + 'make -B dist-xz', or 'make -B dist-gz'. Versions - Use the DISTVERSION variable when running make(1) to specify a version - different than the default, which is generated with git-describe(1). - This needs to be done from the git repository, and won't work from an - extracted tarball. + Use the DISTVERSION variable when running make(1) to specify a + version different than the default, which is generated with + git-describe(1). This needs to be done from the git repository, + and won't work from an extracted tarball. $ make -B dist-xz DISTVERSION=6.01+43 Caveats - The version and date of last modification for each page is hardcoded - by the Makefile into the pages when the tarball is generated. This - means that it's not possible to generate a valid tarball from another - extracted tarball, since the version and date will not be updated. - Tarballs need to be created from the git(1) repository. + The version and date of last modification for each page is + hardcoded by the Makefile into the pages when the tarball is + generated. This means that it's not possible to generate a valid + tarball from another extracted tarball, since the version and + date will not be updated. Tarballs need to be created from the + git(1) repository. |