Scripts: Difference between revisions
Jump to navigation
Jump to search
m (→Maintenance) |
|||
Line 10: | Line 10: | ||
== Building Documentation == | == Building Documentation == | ||
=== User Manual === | |||
* doc/'''fixdox.sh''' - fix up the texi file for proper generation of the final document | |||
* doc/'''t2h.pl''' - texi2html converter which also generates the files needed for chm creation | |||
=== Sourcecode (Doxy) === | |||
* doc/'''mkdoxy.sh''' - main script to create doxygen documentation. contains a lot of magic to create nicely linked output | * doc/'''mkdoxy.sh''' - main script to create doxygen documentation. contains a lot of magic to create nicely linked output | ||
** doc/'''src2doxy.sh''' | ** doc/'''src2doxy.sh''' | ||
** doc/'''txt2doxy.sh''' | ** doc/'''txt2doxy.sh''' |
Revision as of 18:00, 8 October 2020
There are a couple of scripts in the source tree that help with some tasks during development
Maintenance
- checkactivity.sh - creates some statistics from the svn log
- src/findhacks.sh - finds defines and ifdefs that perhaps can be removed. also finds printf-style output that perhaps shouldnt be there
- doc/checkdoc.mak , checkdoc.c - extracts resources from the executables and compares with vice.texi
- gtk3resources.py - finds resource definitions in the GTK3 ui
- src/html/checklinks.sh - checks (internal and external) links in the html pages
Building Documentation
User Manual
- doc/fixdox.sh - fix up the texi file for proper generation of the final document
- doc/t2h.pl - texi2html converter which also generates the files needed for chm creation
Sourcecode (Doxy)
- doc/mkdoxy.sh - main script to create doxygen documentation. contains a lot of magic to create nicely linked output
- doc/src2doxy.sh
- doc/txt2doxy.sh
Building
- autogen.sh - generates the configure script
- src/resid/samp2src.pl - generate tables as c-arrays
- ./src/buildtools/geninfocontrib_h.sh - extracts the team list(s) from vice.texi and inserts into infocontrib.h, index.html, AUTHORS, README
- build/mingw/vice-rpm-to-deb.sh - convert Fedora mingw64-*.rpm packages to .deb for use with a Debian-based cross-compiler for the Gtk3 UI
- FIXME: Frankenvice scripts were moved into `./frankenvice` and we also have a `./docker` subdir now
- TODO: document and check these:
./build/android/build-android.sh ./build/android/push-roms.sh ./src/vice-version.sh - generated by configure? ./src/wrap-u-ar.sh ./src/buildtools/bin2c.sh ./src/buildtools/convert_owcc_libs.sh -- OpenWatcom? Probably can delete this ./src/buildtools/gensvnversion.sh ./src/buildtools/od2c.sh ./src/buildtools/palette2c.sh ./src/arch/android/AnVICE/clean.sh ./src/arch/gtk3/generate-icons-list.sh ./src/arch/gtk3/macOS-ui-runtime.sh ./src/arch/gtk3/make-bindist_osx.sh ./src/arch/gtk3/make-bindist_win32.sh ./src/arch/gtk3/vice-launcher.sh ./src/arch/gtk3/x11-launcher.sh ./src/arch/sdl/macOS-ui-runtime.sh ./src/arch/sdl/make-bindist_amiga.sh ./src/arch/sdl/make-bindist_beos.sh ./src/arch/sdl/make-bindist_osx.sh ./src/arch/sdl/make-bindist_win32.sh ./src/arch/sdl/vice-launcher.sh ./src/arch/sdl/x11-launcher.sh
encoding mess
several scripts need to be updated to deal with the proper encoding of "international" characters (with accents in particular)
- ./src/buildtools/geninfocontrib_h.sh (already handles é and \'e for index.html output)
- TODO: handle infocontrib.h, AUTHORS, README output
iso-8859-1
for the time being, the following files MUST be iso-8859-1, or things will break:
- ./src/buildtools/geninfocontrib_h.sh (encoding is checked in src/Makefile)
- ./doc/vice.texi (encoding is checked in doc/Makefile)