Anonymous avatar Anonymous committed 801d5f7

Added NEWS.txt primer.

Comments (0)

Files changed (8)

 
 dist: clean docs
 	@echo "Creating dist..."
-	@$(PYTHON) setup.py sdist
+	@$(PYTHON) setup.py sdist --format gztar
+	@$(PYTHON) setup.py sdist --format zip
 
 bdist: clean docs
 	@echo "Creating bdist..."
 	@cd doc && make html
 	@mv doc/sphinx/build/html doc/html
 	@rm -rf doc/sphinx/build
+	@cd doc && make docclean
 
 release: dist
 	@$(PYTHON) config/bundle_docs.py
+############
+Release News
+############
+
+This describes the latest changes between the Pygame2 releases.
+
+2.0.0 2009-XX-XX
+================
+
+* Initial Release
 * Rewrite and fix up numpysurfarray and numpysndarray
 * Add prebuilt package for Win32 VC++ builds.
 * Refine quitting for SDL_QuitSubSystem wrapper.
+* Rewrite RST generator to support aliased imports correctly.
 
 Things to ADD:
 ==============
 	-cp -f BuildUnix.txt buildunix.rst
 	-cp -f MODULES.txt newmodules.rst
 	-cp -f MODULE_FAQ.txt module_faq.rst
+	-cp -f ../NEWS.txt news.rst
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  changes   to make an overview over all changed/added/deprecated items"
 	@echo "  linkcheck to check all external links for integrity"
 
-clean:
-	-rm -rf sphinx/build *~ *.pyc *.orig ref html
+docclean:
+	-rm -rf sphinx/build *~ *.pyc *.orig ref
 	-rm -f builddarwin.rst buildmingw.rst buildunix.rst buildvc.rst
-	-rm -f newmodules.rst module_faq.rst
+	-rm -f newmodules.rst module_faq.rst news.rst
+
+clean: docclean
+	-rm -rf html
 
 html: rst
 	mkdir -p sphinx/build/html sphinx/build/doctrees
 of before issueing a new release.
 
 General
--------
+=======
 Releases are split into three phases usually, *alpha*, *rc* and *final*.
 
 Alpha phase
-^^^^^^^^^^^
+-----------
 The *alpha* phase usually takes place as soon as a *final* release was made and
 can feature as many releases as necessary. *alpha* releases should be made
 whenever large changes were made, which change the behaviour, API interfaces or
 releases to be made.
 
 Release Candidate phase
-^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------
 The *rc* phase (short for Release Candidate) enters a beta testing cycle, where
 no new features should be added, but only bug fixes be committed. It is also
 the right time for proof-reading the documentation, running the unit tests on
 release is made.
 
 Final phase
-^^^^^^^^^^^
+-----------
 This is not directly a phase on its own, but simply the day of the final release
 for the specific version. The *final* release usually should be the same as the
 last *rc* release, but only differ by the version number and release date.
 
-Preparations for a release
---------------------------
+Preparations
+============
 Before a new release takes place, the following steps have to be made:
 
-* increase version number (see Postprocessing) in ::
+* increase version number (see :ref:`Postprocessing`) in ::
   
     setup.py
     doc/conf.py
     lib/__init__.py
     
-* update NEWS.txt with the chagnes since the last version (only for final
+* update NEWS.txt with the changes since the last version (only for final
   release - alpha and rc should contain the information, but not be tagged
-  explicitly)
+  explicitly). See :ref:`Editing News` for more information.
 
 * update README.txt and doc/BuildXXX.txt to point to the latest required
   dependency versions.
 
+
+Editing News
+============
+The NEWS.txt file contains information about the changes between two
+*final* releases. If possible, it should be always up to date with the
+latest SVN changes.
+
+For adding a new release entry, the following layout is used: ::
+
+  VERSION DATE
+  ============
+
+  [Change list]
+
+
+Each important change that has any impact on the API (be it bug fixes,
+behaviour changes or whatever else), should be described here. If it was
+a user-submitted fix or change, credits are given to the user. If it was
+a fix for some user-submitted bug report, a short pointer to the report
+location should be given. If it was a fix for some bug tracker entry, the
+tracker id should be added. ::
+
+  2.99.4 2034-12-20
+  =================
+
+  * Added foo.morefoo class.
+  * Bug: Fixed foo.bar () misbehaviour for string arguments (via mailing list).
+  * Added foo.barbaz () method for whatever (thanks to Emily Doe).
+  * Bug #1234: Fixed foo.foobar() return value.
+
 Releasing
----------
+=========
 TODO
 
 Postprocessing
---------------
-
+==============
 Right after a release has been made and the tree was tagged correctly, the
 version numbers should be increased (and revised just before the next release).
 
-#############
-Pygame2 C API
-#############
+###################
+C API Documentation
+###################
 
 The following sections cover the internal C API of Pygame2. The C API is useful
 for implementing your own C extension or if you require some Python to C
 .. toctree::
    :maxdepth: 1
 
+   news.rst
    building.rst
    tutorial/index.rst
    modules.rst
+   capi.rst
    extending.rst
-   capi.rst
 
 .. todolist::
 
-###############
-Pygame2 modules
-###############
+####################
+Module Documentation
+####################
 
 This is the core documentation of the various modules, classes and
 functions, pygame2 offers. If you want a quick module overview, use the
 method or function, use the :ref:`genindex` or :ref:`search`.
 
 General Notes for Reading
--------------------------
+=========================
 
 .. note::
 
   important for Python 3.x users and the new :mod:`io` module.
 
 Modules
----------
+=======
 
 .. toctree::
    :maxdepth: 2
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.