doc: Update documentation about making releases

This commit is contained in:
Tom Henderson
2022-11-02 07:01:09 -07:00
parent ad43a52197
commit 65fa318a0c

View File

@@ -359,17 +359,19 @@ We change the VERSION field from '3-dev' to '3.34'::
$ cat VERSION
3.34
We next change the file conf.py in the tutorial, manual, and models directories
We next change the file conf.py in the contributing, tutorial, manual, and models directories
to change the strings 'ns-3-dev' to ns-3.34.
When you are done, the 'git status' command should show:
When you are done, the 'git diff --stat' command should show:
::
VERSION | 2 +-
doc/manual/source/conf.py | 4 ++--
doc/models/source/conf.py | 4 ++--
doc/tutorial/source/conf.py | 4 ++--
VERSION | 2 +-
doc/contributing/source/conf.py | 4 ++--
doc/manual/source/conf.py | 4 ++--
doc/models/source/conf.py | 4 ++--
doc/tutorial/source/conf.py | 4 ++--
5 files changed, 9 insertions(+), 9 deletions(-)
Make a commit of these files:
@@ -377,17 +379,23 @@ Make a commit of these files:
$ git commit -a -m"Update VERSION and documentation tags for ns-3.34 release"
Next, make the following change to RELEASE_NOTES and commit it:
Next, make the following change to RELEASE_NOTES.md and commit it:
::
Availability
------------
-This release is not yet available.
-Release 3-dev
--------------
+Release 3.34
+------------
+
+### Availability
+
+This release is available from:
+https://www.nsnam.org/release/ns-allinone-3.34.tar.bz2
+<https://www.nsnam.org/release/ns-allinone-3.34.tar.bz2>
$ git commit -m"Update availability in RELEASE_NOTES" RELEASE_NOTES
Commit this change:
$ git commit -m"Update availability in RELEASE_NOTES.md" RELEASE_NOTES.md
Finally, add a git annotated tag: