summaryrefslogtreecommitdiff
path: root/RELEASE-HOWTO.md
diff options
context:
space:
mode:
authorHans Ulrich Niedermann <hun@n-dimensional.de>2021-12-09 11:50:14 +0100
committerHans Ulrich Niedermann <hun@n-dimensional.de>2021-12-09 11:50:14 +0100
commitd5718faf16d015eab3efdd22e3e65adf438c3d4f (patch)
treee9c6aa0bc165384f1025f06e6f4e5ed5350d405d /RELEASE-HOWTO.md
parent22ea3d2f6f92c1a8bce16a0de992caeb665e0ea3 (diff)
downloadlibgphoto2-d5718faf16d015eab3efdd22e3e65adf438c3d4f.tar.gz
RELEASE-HOWTO.md: Improve markdown readability
Improve markdown readability, both as text and rendered as HTML.
Diffstat (limited to 'RELEASE-HOWTO.md')
-rw-r--r--RELEASE-HOWTO.md85
1 files changed, 43 insertions, 42 deletions
diff --git a/RELEASE-HOWTO.md b/RELEASE-HOWTO.md
index c2db4b5ff..5fe5bcde9 100644
--- a/RELEASE-HOWTO.md
+++ b/RELEASE-HOWTO.md
@@ -8,63 +8,64 @@
## sync translations from translationproject
- In the toplevel directory (of which po/ is a subdirectory)
+ In the toplevel directory (of which `po/` is a subdirectory)
- rsync -Lrtvz translationproject.org::tp/latest/libgphoto2/ po
- cd libgphoto2\_port
- rsync -Lrtvz translationproject.org::tp/latest/libgphoto2\_port/ po
- cd ..
+ rsync -Lrtvz translationproject.org::tp/latest/libgphoto2/ po
+ rsync -Lrtvz translationproject.org::tp/latest/libgphoto2_port/ libgphoto2_port/po
- if gphoto2 is released too:
- rsync -Lrtvz translationproject.org::tp/latest/gphoto2/ po
+ If gphoto2 is released too:
- For updated files, use
+ rsync -Lrtvz translationproject.org::tp/latest/gphoto2/ po
+
+ For each updated '**/po/*.po' file, use
+
+ git commit LANG.po --author="Last translator from the po file"
- git commit LANG.po --author="Last translator from po file"
-
to make it clear who did the change.
## sync music-players.h from libmtp
- (We ship this to give additional device support for distributions
- that might update libmtp less often.)
+ We ship the `music-players.h` file from libmtp to give additional
+ device support for distributions that might update libmtp less
+ frequently.
Copy over from libmtp and commit.
## test cameras
- Run: make check
+ Run: `make check`
- In the gphoto2 checkout I am running <code>perl tests/testcamera.pl</code>
- for several cameras that might have been affected by the current release.
+ In the gphoto2 checkout I am running `perl tests/testcamera.pl` for
+ several cameras that might have been affected by the current
+ release.
## update NEWS
- git diff libgphoto2-2\_5\_21-release.. | less
+ git diff libgphoto2-2\_5\_21-release.. | less
summarize changes
## tag release
- bump version in configure.ac, NEWS, commit and push.
+ bump version in `configure.ac`, `NEWS`, commit and push.
- make clean
- make
- sudo make install
+ make clean
+ make
+ sudo make install
## build and sign release ŧarballs
- make distcheck
+ make distcheck
- this builds .gz, .bz2 and .xz tarballs currently.
+ this builds `.gz`, `.bz2` and `.xz` tarballs currently.
GPG detach sign:
- gpg --detach-sign -a libgphoto2-2.5.27.tar.bz2
- gpg --detach-sign -a libgphoto2-2.5.27.tar.gz
- gpg --detach-sign -a libgphoto2-2.5.27.tar.xz
+ gpg --detach-sign -a libgphoto2-2.5.27.tar.bz2
+ gpg --detach-sign -a libgphoto2-2.5.27.tar.gz
+ gpg --detach-sign -a libgphoto2-2.5.27.tar.xz
- this will create .asc files alongside the tarballs.
+ this will create `.asc` files alongside the tarballs.
Similar when doing the gphoto2 release.
@@ -72,21 +73,21 @@
Do old style and new style GIT tagging (new style for github largely)
- git tag libgphoto2-2\_5\_27-release
- git tag v2.5.27
- git push --tags
+ git tag libgphoto2-2\_5\_27-release
+ git tag v2.5.27
+ git push --tags
## create a README for sourceforge
- paste the NEWS blob from this release into README for uploading
+ Paste the `NEWS` blob from this release into `README` for uploading.
## SF upload
- Create a new folder below libgphoto2 with the release number in it (Add Folder)
+ Create a new folder below `libgphoto2` with the release number in it (Add Folder).
- Inside that "Add File" of the tarballs, the .asc files and the README.
+ Inside that "Add File" of the tarballs, the `.asc` files and the `README`.
- After upload, select "Info" on the .tar.bz2 tarball, and "Select All" for the Default download.
+ After upload, select "Info" on the `.tar.bz2` tarball, and "Select All" for the Default download.
This will make it point the "default download" link to this tarball.
If you are uploading gphoto2, do the same ... but do not select it for the default download.
@@ -98,7 +99,7 @@
"Draft a new release"
Select the new release tag. Name is "2.5.27 release",
- paste in the NEWS blob into the textfield.
+ paste in the `NEWS` blob into the textfield.
## Edit the website
@@ -108,21 +109,21 @@
### news/index.php
- Paste in the NEWS blob, htmlify with h2 - h3 and ul/li lists, same as the ones before
+ Paste in the `NEWS` blob, htmlify with h2 - h3 and ul/li lists, same as the ones before
### proj/libgphoto2/support.php
- Adjust the date (LANG=C date).
+ Adjust the date (`env LANG=C date`).
- Adjust the gphoto2 --version blob (LANG=C gphoto2 --version). Make sure you have the correct versions in there.
+ Adjust the `gphoto2 --version` blob (`env LANG=C gphoto2 --version`). Make sure you have the correct versions in there.
Replace the table with fresh output of:
- /usr/lib64/libgphoto2/print-camera-list html
+ /usr/lib64/libgphoto2/print-camera-list html
### Upload via sftp
- see upload.sh ... html tree starts below htdocs/ on the server.
+ see `upload.sh` ... html tree starts below `htdocs/` on the server.
Do not forget to "svn ci" the changes.
@@ -132,7 +133,7 @@
## Announce to mailing list
- Write a summary email to gphoto-user@lists.sourceforge.net, gphoto-devel@lists.sourceforge.net
+ Write a summary email to `gphoto-user@lists.sourceforge.net`, `gphoto-devel@lists.sourceforge.net`.
Add download links to either SF or GITHUB.
@@ -156,6 +157,6 @@
/msg Chanserv topic #gphoto Digital cameras for Linux/UNIX/MacOS | http://gphoto.org/ | just ask | no webcams | newest 2.5.27
-## Make git ready for further development
+## Prepare git repo for further development
- Rev NEWS and configure.ac versions to 2.5.27.1 devel release.
+ Rev `NEWS` and `configure.ac` versions to 2.5.27.1 devel release.