aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2022-02-26 00:21:50 +0100
committerJay Berkenbilt <ejb@ql.org>2022-02-26 00:21:50 +0100
commitdca0c7eae6ac18852f7ae46da67440df50d47fa8 (patch)
treedbf393433c2e27cc9ef1ab90669187e91fac9bb2
parent905e99a3141edc7d6523e8da47e624b1c1e664a3 (diff)
downloadqpdf-dca0c7eae6ac18852f7ae46da67440df50d47fa8.tar.zst
Simplify confusing terminology in the README and manual (fixes #660)
Some people don't know what CI is, so remove use of that abbreviation when it doesn't add any value.
-rw-r--r--README.md2
-rw-r--r--manual/design.rst7
2 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index 7ba99b1c..95281fcf 100644
--- a/README.md
+++ b/README.md
@@ -103,7 +103,7 @@ QPDF is known to build and pass its test suite with mingw (latest version tested
# Building Documentation
-The QPDF manual is written in reStructured Text format and is build with [sphinx](https://www.sphinx-doc.org). The sources to the user manual can be found in the `manual` directory. For more detailed information, consult the [Building and Installing QPDF section of the manual](manual/installation.rst) or consult the [build-doc script used in CI](build-scripts/build-doc).
+The QPDF manual is written in reStructured Text format and is build with [sphinx](https://www.sphinx-doc.org). The sources to the user manual can be found in the `manual` directory. For more detailed information, consult the [Building and Installing QPDF section of the manual](manual/installation.rst) or consult the [build-doc script](build-scripts/build-doc).
# Additional Notes on Build
diff --git a/manual/design.rst b/manual/design.rst
index 0e50f858..f323aa75 100644
--- a/manual/design.rst
+++ b/manual/design.rst
@@ -375,9 +375,10 @@ packed together in some integer type. Also note that ``size_t`` and
so sometimes an explicit cast may not be needed to avoid warnings on one
platform but may be needed on another. A conversion with ``QIntC``
should always be used when the types are different even if the
-underlying size is the same. QPDF's CI build builds on 32-bit and 64-bit
-platforms, and the test suite is very thorough, so it is hard to make
-any of the potential errors here without being caught in build or test.
+underlying size is the same. QPDF's automatic build builds on 32-bit
+and 64-bit platforms, and the test suite is very thorough, so it is
+hard to make any of the potential errors here without being caught in
+build or test.
Non-const ``unsigned char*`` is used in the ``Pipeline`` interface. The
pipeline interface has a ``write`` call that uses ``unsigned char*``