summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSébastien Wilmet <swilmet@informatique-libre.be>2022-05-07 08:45:35 +0200
committerSébastien Wilmet <swilmet@informatique-libre.be>2022-05-07 08:47:31 +0200
commitfcd99a1c96a2b0a9b865cf24de117a251f8b81a0 (patch)
tree6ee642c21874125763d4a318fefaf06a1a2d135f
parent1cd9eea2cf8a4f44e64a69be02eedca62e0d774a (diff)
downloadgtk-doc-fcd99a1c96a2b0a9b865cf24de117a251f8b81a0.tar.gz
hacking: some updates and simplifications
I think we'll adopt a major.minor.micro version numbering scheme, even for stable versions. The NEWS file can communicate about versions being unstable/development snapshots.
-rw-r--r--HACKING70
1 files changed, 20 insertions, 50 deletions
diff --git a/HACKING b/HACKING
index 69b8b6b..82e6b09 100644
--- a/HACKING
+++ b/HACKING
@@ -1,3 +1,14 @@
+Old website
+===========
+
+See: https://gitlab.gnome.org/Infrastructure/gtk-web (in the git history)
+
+The `gtk-doc/` directory has been removed after a big update to
+[gtk.org](https://gtk.org/)
+
+But it can contain useful information nevertheless, or a different wording at
+presenting GTK-Doc.
+
Testing
=======
@@ -16,62 +27,21 @@ fail and show the delta.
Releasing
=========
-http://live.gnome.org/MaintainersCorner/Releasing
+General: https://wiki.gnome.org/MaintainersCorner/Releasing
-'''shell
-export OLD_VER=1.31
-export NEW_VER=1.32
-export OLD_VER_TAG=$(echo ${OLD_VER} | tr '.' '_')
-export NEW_VER_TAG=$(echo ${NEW_VER} | tr '.' '_')
-export GNOME_USER=...
-```
-
-- bump release date in:
- help/manual/C/index.docbook
-- bump version in (x.y.1 -> x.y+1)
- configure.ac meson.build
+Specific to GTK-Doc
+-------------------
-- update NEWS
+- Version numbers and release dates are also present in:
+ `help/manual/C/index.docbook`
-```shell
-# commit
-git add configure.ac meson.build NEWS help/manual/C/index.docbook
-git commit -m"release: update news and date in manual"
-git push
-
-# dist
-TAR_OPTIONS="--owner=root --group=root" make distcheck
-
-# tag
-git tag -a GTK_DOC_${NEW_VER_TAG} -m"release: ${NEW_VER}"
-git push origin GTK_DOC_${NEW_VER_TAG}
-
-# release
-scp gtk-doc-${NEW_VER}.tar.xz ${GNOME_USER}@master.gnome.org:
-ssh ${GNOME_USER}@master.gnome.org "ftpadmin install gtk-doc-${NEW_VER}.tar.xz"
+Some commands:
```
-
-- bump versions in:
- configure.ac meson.build help/manual/C/index.docbook NEWS
-
-``'shell
-# commit
-git add configure.ac meson.build NEWS help/manual/C/index.docbook
-git commit -m"release: bump versions and back to development"
-git push
+TAR_OPTIONS="--owner=root --group=root" make distcheck
```
-- update web-pages (gtk-web/gtk-doc)
- git add gtk-doc/news.php
- git commit -m"gtk-doc: new release (${NEW_VER})"
- git push
-
-- if we want a icon on the newsfeed, we should copy a icon like on
- http://ftp.acc.umu.se/pub/GNOME/sources/rhythmbox/rhythmbox.png
- e.g. /usr/share/icons/hicolor/48x48/apps/devhelp.png
-
-Optimizing & Meassuring
-=======================
+Optimizing & Measuring
+======================
cd tests/gobject/docs/html
time xsltproc --nonet --xinclude --stringparam gtkdoc.bookname "tester" --stringparam gtkdoc.version "1.12" ../../../../gtk-doc.xsl ../tester-docs.xml