misc/abi-check: This new script can be used (on Linux) to check ABI
compatibility between patch releases. It does everything required
in one execution (after installing the prerequisites once).
Documentation is included in the script. It may be modified for
other platforms, or ABI checking can be done manually.
README.abi-version.txt: add a chapter regarding ABI checks
misc/abi-compliance-checker.txt: update documentation on how to run
misc/abi-check. In previous versions (1.4) building was done using
configure/make. Thus this file was almost completely rewritten.
documentation/src/migration_1_4.dox: an unrelated but tiny correction.
The goal is to change the version number for a new release only in
CMakeLists.txt. This is the second step.
This commit also adds a chapter "Migrating Code from FLTK 1.4 to 1.5".
Details:
- documentation/CMakeLists.txt: configure 'version.dox'
- fluid/documentation/CMakeLists.txt: same as above
- documentation/Doxyfile.in: add "Migrating Code from FLTK 1.4 to 1.5"
- documentation/src/index.dox: include 'version.dox' and 'migrating...'
- fluid/documentation/src/index.dox: same as above
- documentation/src/preface.dox: include 'version.dox'
- documentation/version.dox.in: input to CMake configure 'version.dox'
- fluid/documentation/version.dox.in: same as above
- documentation/src/migration_1_4.dox: update links
- documentation/src/migration_1_5.dox: new documentation chapter
The goal is to change the version number for a new release only in
CMakeLists.txt. This is the first step.
Details:
- CMake/gen_config.cmake: this new file is included to generate the
header files config.h (private, root directory), and FL/fl_config.h
(public, can be installed). This file implements also ABI version
checks (removed from FL/Enumerations.H and with more checks).
Warnings are issued if the chosen ABI version is invalid.
- CMake/export.cmake: code to generate 'config.h' was moved to
CMake/gen_config.cmake.
- CMake/options.cmake: set default of FLTK_BUILD_FORMS=OFF + comments
- CMakeLists.txt: move generation of FL/fl_config.h to gen_config.cmake,
add API and ABI versions to CMake summary,
- FL/Enumerations.H: remove most of the version number details which
are now included in FL/fl_config.h. This needed also some doxygen
related changes.
- README.CMake.txt: improve docs of FL_ABI_VERSION and some more.
Reflect the new default of CMake option FLTK_BUILD_FORMS (OFF).
- documentation/Doxyfile.in: add FL/fl_config.h to file list. This
file is created in the build tree (and may be "installed").
- fl_config.h.in: add version number details that have been moved here
from Enumerations.H (used to generate FL/fl_config.h).
Remove references to "current" version numbers, use 1.2.3 as example
for clarity and to simplify version number updates.
Also: minor textual fixes (typos), unwrap lines, etc..
Todo: Documentation states:
"This file is not actively maintained any more, but is left here
as a reference, until the doxygen documentation is completed."
Check if the documentation generated by doxygen from source files
contains everything needed so this file can be removed.
Prepare for installation of `games` demo programs. Fix inconsistencies
and typos in man pages. In the future the man pages can be installed
together with the executables. This will be done in a later commit.
documentation/src/glpuzzle.man: new file.
It notably honors SOURCE_DATE_EPOCH if set, making for reproducible
output. For even better reproducibility, use UTC. (Unlike the date
command's output, the result is already always in English.) Extend
this approach to the book, introducing appropriately formatted
PDF_DATE and TODAY variables for its PDF metadata and title page
respectively and making make_pdf configurable.
All files: remove autoconf/configure related stuff, update links.
- README.txt: describe prerequisites, provide generic instructions
on how to use CMake to build FLTK
- test/demo.cxx: remove code used for configure/make build
- test/CMakeLists.txt: remove obsolete 'target_compile_definitions()'
- move linker rule from 'all' to '$(TARGET)'
- remove '$(TARGET) $(OBJS)' from rule 'clean'
The 'clean' rule required to build everything before it was deleted
which was obviously not intended.
1) Improve and clarify documentation:
- update, reformat, and reorder parts of CREDITS.txt
- make sure that documentation appears in doxygen docs
- add '\since 1.4.0' to documentation of new methods and functions
- remove doxygen's '\brief' where not required (we're using
JAVADOC_AUTOBRIEF = YES)
- clarify screen scaling, scaling factor, and related stuff
- add more info about backwards compatibility for X11 specific code
2) Update dependencies
- fix missing doxygen version in PDF docs created by CMake
- remove unnecessary quotes ('...') from version numbers and
Git revisions (previously added for debugging purposes)
- fix navigation links at the bottom of tutorial pages (HTML only)
- remove 'D. Gibson' from documentation headers on his request
Note: one goal is to have to edit fewer version numbers in source
files for each release.
We may be able to generate some files by the build procedure (CMake)
to avoid editing them in the future (1.5.0 or later).
