diff --git a/ChangeLog b/ChangeLog index 78015087..7aba2832 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +2017-08-22 Jay Berkenbilt + + * Convert all README files to markdown. Names changed as follows: + - README --> README.md + - README.hardening --> README-hardening.md + - README.maintainer --> README-maintainer.md + - README-what-to-download.txt --> README-what-to-download.md + - README-windows.txt --> README-windows.md + The file README-windows-install.txt remains a text file. + 2017-08-21 Jay Berkenbilt * Add support for writing PCLm files. Most of the work was done by diff --git a/README-maintainer.md b/README-maintainer.md index e6027447..a6f6da29 100644 --- a/README-maintainer.md +++ b/README-maintainer.md @@ -43,7 +43,7 @@ Release Reminders properly handled. * Remember to avoid using operator[] with std::string or - std::vector. See README.hardening for details. + std::vector. See README-hardening.md for details. * Increment shared library version information as needed (LT_* in configure.ac) @@ -110,7 +110,7 @@ Release Reminders * Before releasing, rebuild and test debian package. - * Remember to copy README-what-to-download.txt separately onto the + * Remember to copy README-what-to-download.md separately onto the download area. * Remember to update the web page including putting new documentation diff --git a/README-what-to-download.md b/README-what-to-download.md index 7fae0d2f..c4af7778 100644 --- a/README-what-to-download.md +++ b/README-what-to-download.md @@ -37,7 +37,7 @@ download. If you want to build qpdf for Windows yourself with either MINGW or MSVC 2010, you can download this file and extract it inside the - qpdf source distribution. Please refer to README-windows.txt in + qpdf source distribution. Please refer to README-windows.md in the qpdf source distribution for additional details. Note that you need the 2012-06-20 version or later to be able to build qpdf 3.0 or newer. The 2009-10-24 version is required for qpdf 2.3.1 or @@ -51,6 +51,6 @@ download. libary, it includes a README file and some scripts to help you build it for Windows. qpdf was built using a binary distribution of libjpeg-turbo for Windows. You will also have to provide those. See - README-windows.txt for details. + README-windows.md for details. -If you want to build on Windows, please see also README-windows.txt. +If you want to build on Windows, please see also README-windows.md. diff --git a/README.md b/README.md index 5c15fa3d..1ef028a2 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ QPDF depends on the external libraries "zlib" and "jpeg". These are part of every Linux distribution and are readily available. Download information appears in the documentation. For Windows, you can download pre-built binary versions of these libraries for some -compilers; see README-windows.txt for additional details. +compilers; see README-windows.md for additional details. QPDF requires a C++ compiler that works with STL. Your compiler must also support "long long". Almost all modern compilers do. If you are @@ -82,7 +82,7 @@ Building from a pristine checkout When building qpdf from a pristine checkout from version control, documentation and automatically generated files are not present. Building on Windows from a pristine checkout is not guaranteed to work -because of issues running autoconf; see README-windows.txt for how to +because of issues running autoconf; see README-windows.md for how to handle this. For UNIX and UNIX-like systems, you must have some addditional tools installed to build from the source repository. To do this, you should run @@ -124,8 +124,8 @@ QPDF is known to build and pass its test suite with mingw (latest version tested: gcc 4.6.2), mingw64 (latest version tested: 4.7.0) and Microsoft Visual C++ 2010, both 32-bit and 64-bit versions. MSYS plus ActiveState Perl is required to build as well in order to get make -and other related tools. See README-windows.txt for details on how to -build under Windows, see README-windows.txt. +and other related tools. See README-windows.md for details on how to +build under Windows, see README-windows.md. Additional Notes on Build @@ -137,7 +137,7 @@ obeying the compiler specified with configure. This can be enabled by passing --with-buildrules=buildrules where buildrules corresponds to one of the .mk files (other than rules.mk) in the make directory. This should never be necessary on a UNIX system, but may be necessary -on a Windows system. See README-windows.txt for details. There is a +on a Windows system. See README-windows.md for details. There is a gcc-linux.mk file enable "gcc-linux" build rules, but it is intended to help test the build system; Linux users should build with the "libtools" rules, which are enabled by default. diff --git a/configure.ac b/configure.ac index 8d8e2d15..42d810d2 100644 --- a/configure.ac +++ b/configure.ac @@ -228,7 +228,7 @@ AC_MSG_CHECKING(which build rules to use) AC_SUBST(BUILDRULES) AC_ARG_WITH(buildrules, AS_HELP_STRING([--with-buildrules=rules], - [which build rules to use; see README]), + [which build rules to use; see README.md]), [BUILDRULES=$withval], [BUILDRULES=libtool]) AC_MSG_RESULT($BUILDRULES) diff --git a/libqpdf/SecureRandomDataProvider.cc b/libqpdf/SecureRandomDataProvider.cc index 1720b875..fe9f1d4b 100644 --- a/libqpdf/SecureRandomDataProvider.cc +++ b/libqpdf/SecureRandomDataProvider.cc @@ -118,7 +118,7 @@ SecureRandomDataProvider::provideRandomData(unsigned char* data, size_t len) #else -# error "Don't know how to generate secure random numbers on this platform. See random number generation in the top-level README" +# error "Don't know how to generate secure random numbers on this platform. See random number generation in the top-level README.md" #endif } diff --git a/make/exec-z b/make/exec-z index dc21dbc1..eab305b9 100755 --- a/make/exec-z +++ b/make/exec-z @@ -1,5 +1,5 @@ #!/bin/sh -# This script is used for valgrind testing. See README.maintainer. +# This script is used for valgrind testing. See README-maintainer.md. # Create a suppressions file. This can be updated by running valgrind # with --gen-suppressions=yes. diff --git a/make_dist b/make_dist index a2d496a0..8cca6085 100755 --- a/make_dist +++ b/make_dist @@ -1,7 +1,7 @@ #!/usr/bin/env perl # # This program creates a source distribution of qpdf. For details, -# see README.maintainer. +# see README-maintainer.md. # require 5.008; diff --git a/manual/qpdf-manual.xml b/manual/qpdf-manual.xml index 2dc7c27d..8d6fce6a 100644 --- a/manual/qpdf-manual.xml +++ b/manual/qpdf-manual.xml @@ -87,7 +87,7 @@ Building and Installing QPDF This chapter describes how to build and install qpdf. Please see - also the README and + also the README.md and INSTALL files in the source distribution. @@ -210,17 +210,17 @@ make configured. You can also set the value of DESTDIR during installation to install to a temporary location, as is common with many open source packages. - Please see also the README and + Please see also the README.md and INSTALL files in the source distribution. Building on Windows is a little bit more complicated. For - details, please see README-windows.txt in the + details, please see README-windows.md in the source distribution. You can also download a binary distribution for Windows. There is a port of qpdf to Visual C++ version 6 in the contrib area generously contributed by Jian Ma. This is also discussed in more detail in - README-windows.txt. + README-windows.md. There are some other things you can do with the build. Although @@ -2102,7 +2102,7 @@ outfile.pdf would enable you to use some software-based secure pseudorandom number generator and to avoid use of whatever the operating system provides. For details on how to do this, please refer to the - top-level README file in the source distribution and to comments + top-level README.md file in the source distribution and to comments in QUtil.hh. @@ -3256,7 +3256,7 @@ print "\n"; converts numbers to strings. This is largely invisible to users, but it does trigger a bug in some older versions of mingw-w64's C++ library. See - README-windows.txt in the source + README-windows.md in the source distribution if you think this may affect you. The copy of the DLL distributed with qpdf's binary distribution is not affected by this problem. @@ -3677,7 +3677,7 @@ print "\n"; not needed to verify a correct build or port of qpdf. They are needed only when changing the actual PDF output generated by qpdf. You should enable them if you are making deep - changes to qpdf itself. See README for + changes to qpdf itself. See README.md for details. @@ -3686,7 +3686,7 @@ print "\n"; Large file tests are off by default but can be turned on with ./configure or by setting an environment variable before running the test suite. See - README for details. + README.md for details.