Skip to content

Commit

Permalink
doc: Move all manuals to the manuals/ directory
Browse files Browse the repository at this point in the history
Create the manuals/ directory for storing the software manuals and the
man pages. The upcoming Markdown versions of these document are also
planned to be added here.

Move in the manual files as follows:
 * Move libpng.3 and libpng.5 to manuals/libpng.3 and manuals/libpng.5
 * Move libpng-manual.txt to manuals/libpng-manual.txt
 * Move INSTALL.txt to manuals/libpng-install.txt
 * Remove libpngpf.3

Finally, update the README file, as well as the makefiles and the CMake
file, in order to reflect these changes.
  • Loading branch information
ctruta committed Sep 14, 2024
1 parent 733bd7d commit ed4cf84
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 39 deletions.
4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1109,9 +1109,9 @@ endif()

if(NOT SKIP_INSTALL_FILES AND NOT SKIP_INSTALL_ALL)
# Install the man pages.
install(FILES libpng.3 libpngpf.3
install(FILES manuals/libpng.3
DESTINATION ${CMAKE_INSTALL_MANDIR}/man3)
install(FILES png.5
install(FILES manuals/png.5
DESTINATION ${CMAKE_INSTALL_MANDIR}/man5)
# Install the pkg-config files.
if(NOT CMAKE_HOST_WIN32 OR CYGWIN OR MINGW)
Expand Down
2 changes: 1 addition & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ TESTS =\
endif

# man pages
dist_man_MANS= libpng.3 libpngpf.3 png.5
dist_man_MANS= manuals/libpng.3 manuals/png.5

# generate the -config scripts if required
binconfigs= libpng@PNGLIB_MAJOR@@PNGLIB_MINOR@-config
Expand Down
2 changes: 1 addition & 1 deletion Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -812,7 +812,7 @@ BUILT_SOURCES = pnglibconf.h


# man pages
dist_man_MANS = libpng.3 libpngpf.3 png.5
dist_man_MANS = manuals/libpng.3 manuals/png.5
EXTRA_SCRIPTS = libpng-config libpng@PNGLIB_MAJOR@@PNGLIB_MINOR@-config
bin_SCRIPTS = @binconfigs@

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,19 +104,14 @@ filter heuristics, have since been removed.
Files included in this distribution
-----------------------------------

ANNOUNCE => Announcement of this version, with recent changes
AUTHORS => List of contributing authors
ANNOUNCE.md => Announcement of this version, with recent changes
AUTHORS.md => List of contributing authors
CHANGES => Description of changes between libpng versions
INSTALL => Instructions to install libpng
LICENSE => License to use and redistribute libpng
README => This file
TODO => Things not implemented in the current library
TRADEMARK => Trademark information
LICENSE.md => License to use and redistribute libpng
README.md => This file
TODO.md => Things not implemented in the current library
TRADEMARK.md => Trademark information
example.c => Example code for using libpng functions
libpng.3 => Manual page for libpng (includes libpng-manual.txt)
libpng-manual.txt => Description of libpng and its functions
libpngpf.3 => Manual page for libpng's private functions (deprecated)
png.5 => Manual page for the PNG format
png.c => Basic interface functions common to library
png.h => Library function and interface declarations (public)
pngpriv.h => Library function and interface declarations (private)
Expand Down Expand Up @@ -165,6 +160,11 @@ Files included in this distribution
testpngs/ => Test images
tools/ => Various tools
visupng/ => VisualPng, a Windows viewer for PNG images
manuals/ => Manuals
libpng-install.txt => Instructions to install libpng
libpng-manual.txt => Description of libpng and its functions
libpng.3 => Manual page for libpng (includes libpng-manual.txt)
png.5 => Manual page for the PNG format
projects/ => Project files and workspaces for various IDEs
owatcom/ => OpenWatcom project
visualc71/ => Microsoft Visual C++ 7.1 workspace
Expand Down
24 changes: 0 additions & 24 deletions libpngpf.3

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit ed4cf84

Please sign in to comment.