Joel editted the documentation for clarity, grammar and technical
correctness. I also moved it in the manual and added @findex
entries. The core work was just polished.
Author: Krzysztof Mięsowicz <krzysztof.miesowicz@gmail.com>
Script does what is expected and tries to do it as
smartly as possible.
+ remove occurrences of two blank comment lines
next to each other after Id string line removed.
+ remove entire comment blocks which only exited to
contain CVS Ids
+ If the processing left a blank line at the top of
a file, it was removed.
Adds documentation on the scheduler options and scheduler selection
to the User's Manual to reflect changes made in the development of
pluggable scheduling with EDF and CBS schedulers.
* ada_user/version.texi, bsp_howto/version.texi,
cpu_supplement/version.texi, develenv/version.texi,
filesystem/version.texi, networking/version.texi,
porting/version.texi, posix1003.1/version.texi,
posix_users/version.texi, shell/version.texi, started/version.texi,
user/version.texi: Update to match when files in directory where last
touched.
* ada_user/Makefile.am, ada_user/ada_user.texi, user/Makefile.am,
user/c_user.texi, user/concepts.t, user/overview.t,
user/preface.texi, user/schedule.t, user/sem.t: Add table of figures.
Add text and graphic of tree illustrating valid combinations of
semaphore attributes.
* user/semaphore_attributes.eps, user/semaphore_attributes.png:
New files.
* ada_user/Makefile.am, user/Makefile.am, user/concepts.t: Add 16 bit
object Id format information.
* user/ObjectId-16Bits.eps, user/ObjectId-16Bits.png: New files.
* ada_user/ada_user.texi, bsp_howto/bsp_howto.texi,
cpu_supplement/cpu_supplement.texi, develenv/develenv.texi,
filesystem/filesystem.texi, itron3.0/itron.texi,
networking/networking.texi, porting/porting.texi,
posix1003.1/posix1003_1.texi, posix_users/posix_users.texi,
rgdb_specs/rgdb_specs.texi, rtems_gdb/rtems_gdb.texi,
started/started.texi, started_ada/started_ada.texi, user/c_user.texi:
Print table of contents in front of manual where it should be when
you print.
* ada_user/Makefile.am, ada_user/ada_user.texi,
cpu_supplement/Makefile.am, cpu_supplement/cpu_supplement.texi,
cpu_supplement/sparc.t: Add Blackfin CPU supplement chapter and get
everything building from previous breakages.
* cpu_supplement/bfin.t: New file.
* SUPPORT, LICENSE: New files.
* Numerous files touched as part of merging the 4.5 branch
onto the mainline development trunk and ensuring that the
script that cuts snapshots and releases works on the documentation.
<corsepiu@faw.uni-ulm.de> which:
* should fix the building rtemsdoc outside of the sourcetree with
relative srcdir issue
* adds --enable-papersize=[letter|a4|]
which splits the current monolithic specs files into a sequence of
subparts. These can be concatenated togather to make a the whole .spec
file. This cleans up the maintenance problem of having "all languages"
and a "C/C++ only" gccnewlib spec files. Plus it should make it easier
to produce variants like the gdb-m68k-bdm which require special hackery. :)
Ralf's comments:
It addresses the way *.spec.in get composed inside of the source
tree.
Changes:
* Each spec.in is broken into several files (*.add), one *.add file
per sub-package.
* Each Makefile.am composes spec.ins from the *.add files
* Removal of redundant automake support files.
* Default value for BuildRoot changed to /tmp/<spec-file-name>
* %clean stage added to *specs
Advantages (IMHO).
* The *.add files are easier to adminstrate and more flexible in
comparison to the former *.specs.ins.
* gccnewlib_c_only.spec.in now is composed from the same sources as
gccnewlib.spec.in (less errors)
* If using the default BuildRoot --clean now deletes all files that
were generated while building.
Notes:
* rtems.spec.in has not yet been adapted to the scheme used for the
other *spec.ins
* Except for cosmetical changes the internals of the *.spec files
should not have changed.
To Apply:
cvs rm -f scripts/binutils/binutils.spec.in
cvs rm -f scripts/gccnewlib/gccnewlib.spec.in
cvs rm -f scripts/gccnewlib/gccnewlib_c_only.spec.in
cvs rm -f scripts/gdb/gdb.spec.in
cvs rm -f scripts/config.sub
cvs rm -f scripts/config.guess
cvs rm -f scripts/install-sh
cvs rm -f scripts/mkinstalldirs
cvs rm -f scripts/missing
patch -p1 < rtems-rc-4.5.0-21.diff
cvs add scripts/*/*.add
cvs add scripts/*/README
Ralf's comments follow:
Changes:
* Enhanced versioning:
- Addition of automake's version.texi support
- Replacement of rtemsdoc's former versioning support by automake's
versioning support (Abandoning RTEMS-UPDATE-* etc.)
- Abandoning setup.texi.in
- Add EDITION to each documents Makefile.am
- version.texi support in project.am
- Addition of maintainer mode (currently only used to prevent incorrectly
updating timestamps when users touch automake's version.texi timestamp
files (stamp-vti)).
* Fixing info dir support
- Use texinfo's @dircategory and @direntry instead of infos *-DIR-ENTRY
- $(infodir)/dir is now correctly set up
* Avoid using temporary files
- Pipe texts through REPLACE2 into BMENU2 instead of using temporary files.
- Abandon using bmenu in favor of bmenu2 (bmenu could be removed now)
* Prepare Makefile.ams for building in a separate buildtree
- prefix files with $(srcdir) in Makefile.am for files which must be
generated inside of the source tree
Notes:
* rtemsdoc can not yet be build in a separate source-tree, but we
are very close to it.
* You as the maintainer of this package now should always use
--enable-maintainer-mode to configure rtemsdoc.
It addresses:
* .cvsignore (only minor changes to yours, as they were pretty clean,
most changes result from my mkcvsignore script being overly pedantic
sorting entries alphabetically.)
* timing.t handling and time<BSP>_.texi handling in supplements
* network.t handling in bsp_howto
* RTEMS_DATE and RTEMS_UPDATE handling in configure.in. [It actually is
a hack, as we could apply automake's version.texi handling instead - I
know think to understand what automake does with it.]
* avoid using temporary files; Therefore a new tool called bmenu2,
derived from bemenu, is introduced, which reads a single file from stdin
and writes to stdio.
To apply:
cd rtemsdoc
patch -p1 < rtemsdoc-4.5.0-rc-3.diff
cvs rm -f bsp_howto/network.t
cvs add tools/bmenu/bmenu2.c
./bootstrap
BTW: word-replace now is unused. It could be removed if you like to.
