F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update references to RELEASE_NOTES

Browse Source
This commit is contained in:
Tom Henderson
2021-11-03 18:01:13 -07:00
parent cc9b568374
commit 80134a570d
6 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -80,7 +80,7 @@ Before creating bug reports, please check [this list](#before-submitting-a-bug-r
#### Before Submitting A Bug Report (to be completed)
* **Perform a [cursory search](https://gitlab.com/nsnam/ns-3-dev/issues)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
* **Check the [release notes](RELEASE_NOTES)** for a list of known bugs.
* **Check the [release notes](RELEASE_NOTES.md)** for a list of known bugs.
#### How Do I Submit A (Good) Bug Report?

2
README.md
View File

@@ -60,7 +60,7 @@ in the directory which contains this README file. The files
built will be copied in the build/ directory.
The current codebase is expected to build and run on the
set of platforms listed in the [release notes](RELEASE_NOTES)
set of platforms listed in the [release notes](RELEASE_NOTES.md)
file.
Other platforms may or may not work: we welcome patches to

2
doc/contributing/source/enhancements.rst
View File

@@ -61,7 +61,7 @@ open, add a comment to the existing issue instead of opening a new one.
If you are reporting an issue against an older version of |ns3|, please
scan the most recent
`Release Notes <https://gitlab.com/nsnam/ns-3-dev/-/blob/master/RELEASE_NOTES>`_ to see if it has been fixed since that release.
`Release Notes <https://gitlab.com/nsnam/ns-3-dev/-/blob/master/RELEASE_NOTES.md>`_ to see if it has been fixed since that release.
If you then decide to list an issue, include details of your environment:

2
doc/contributing/source/models.rst
View File

@@ -245,7 +245,7 @@ update existing or write new documentation and example code. Consider the
following checklist:
* Doxygen should be added to header files for all public classes and methods, and should be checked for Doxygen errors
* new features should be described in the ``RELEASE_NOTES``
* new features should be described in the ``RELEASE_NOTES.md``
* public API changes (if any) must be documented in ``CHANGES.html``
* new API or changes to existing API must update the inline doxygen documentation in header files
* consider updating or adding a new section to the manual (``doc/manual``) or

6
doc/release_steps.txt
View File

@@ -15,7 +15,7 @@ This overview covers the following release stages:
During the software development phase, it is important for the release
manager to try to maintain the following files with updated information:
- AUTHORS
- RELEASE_NOTES
- RELEASE_NOTES.md
- CHANGES.html
otherwise, this becomes painful to edit (and things are forgotten)
@@ -32,7 +32,7 @@ and/or the buildbots have been testing
-- ./waf --pyrun src/flow-monitor/examples/wifi-olsr-flowmon.py --vis
- ensure that tests pass (./test.py -g) and make sure that the buildbots
are reporting 'pass' state, based on the tip of the repository
- revise and check in AUTHORS, RELEASE_NOTES, and CHANGES.html
- revise and check in AUTHORS, RELEASE_NOTES.md, and CHANGES.html
- required versions for related libraries (netanim, pybindgen)
are correct
- confirm that Doxygen builds cleanly (./waf doxygen),
@@ -193,7 +193,7 @@ Announcing
4) maintaining the release
--------------------------
First, create skeletal sections in CHANGES.html and RELEASE_NOTES to
First, create skeletal sections in CHANGES.html and RELEASE_NOTES.md to
start collecting inputs for the ns-3.(x+1) release.
The project may decide to make incremental, bug-fix releases from

13
doc/tutorial/source/conceptual-overview.rst
View File

@@ -157,12 +157,11 @@ directory structure something like the following:
.. sourcecode:: bash
AUTHORS examples scratch utils waf.bat*
bindings LICENSE src utils.py waf-tools
build ns3 test.py* utils.pyc wscript
CHANGES.html README testpy-output VERSION wutils.py
doc RELEASE_NOTES testpy.supp waf* wutils.pyc
AUTHORS doc RELEASE_NOTES.md utils waf-tools
bindings examples scratch utils.py wscript
CHANGES.html LICENSE src VERSION wutils.py
contrib Makefile test.py waf
CONTRIBUTING.md README.md testpy.supp waf.bat
Change into the ``examples/tutorial`` directory. You should see a file named
``first.cc`` located there. This is a script that will create a simple
@@ -899,7 +898,7 @@ most of our *repositories* will look:
-rw-r--r-- 2009-07-01 12:47 +0200 30961 CHANGES.html file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 17987 LICENSE file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 3742 README file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 16171 RELEASE_NOTES file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 16171 RELEASE_NOTES.md file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 6 VERSION file | revisions | annotate
-rwxr-xr-x 2009-07-01 12:47 +0200 88110 waf file | revisions | annotate
-rwxr-xr-x 2009-07-01 12:47 +0200 28 waf.bat file | revisions | annotate