OpenSystemsDevelopment / qpdf

Commit dca0c7eae6ac18852f7ae46da67440df50d47fa8

Authored by Jay Berkenbilt
1 parent 905e99a3

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.
Inline Side-by-side
Showing 2 changed files with 5 additions and 4 deletions
README.md
  View file @dca0c7e
@@ -103,7 +103,7 @@ QPDF is known to build and pass its test suite with mingw (latest version tested @@ -103,7 +103,7 @@ QPDF is known to build and pass its test suite with mingw (latest version tested
103 103
104 # Building Documentation 104 # Building Documentation
105 105
106 -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). 106 +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).
107 107
108 # Additional Notes on Build 108 # Additional Notes on Build
109 109
manual/design.rst
  View file @dca0c7e
@@ -375,9 +375,10 @@ packed together in some integer type. Also note that ``size_t`` and @@ -375,9 +375,10 @@ packed together in some integer type. Also note that ``size_t`` and
375 so sometimes an explicit cast may not be needed to avoid warnings on one 375 so sometimes an explicit cast may not be needed to avoid warnings on one
376 platform but may be needed on another. A conversion with ``QIntC`` 376 platform but may be needed on another. A conversion with ``QIntC``
377 should always be used when the types are different even if the 377 should always be used when the types are different even if the
378 -underlying size is the same. QPDF's CI build builds on 32-bit and 64-bit  
379 -platforms, and the test suite is very thorough, so it is hard to make  
380 -any of the potential errors here without being caught in build or test. 378 +underlying size is the same. QPDF's automatic build builds on 32-bit
  379 +and 64-bit platforms, and the test suite is very thorough, so it is
  380 +hard to make any of the potential errors here without being caught in
  381 +build or test.
381 382
382 Non-const ``unsigned char*`` is used in the ``Pipeline`` interface. The 383 Non-const ``unsigned char*`` is used in the ``Pipeline`` interface. The
383 pipeline interface has a ``write`` call that uses ``unsigned char*`` 384 pipeline interface has a ``write`` call that uses ``unsigned char*``