Spell check

Jay Berkenbilt
1 parent 2a8cd4ac
Showing 12 changed files with 144 additions and 18 deletions
README-maintainer.md
README-what-to-download.md
README-windows.md
README.md
configure.ac
examples/pdf-create.cc
include/qpdf/QPDF.hh
include/qpdf/QPDFWriter.hh
ispell-words
libqpdf/QPDFObjectHandle.cc
libqpdf/QPDFWriter.cc
qpdf/qpdf.cc
 # Release Reminders
  
-* Test for binary compatility. The easiest way to do this is to check out the last release, run the test suite, check out the new release, run `make build_libqpdf`, check out the old release, and run `make check NO_REBUILD=1`.
+* Test for binary compatibility. The easiest way to do this is to check out the last release, run the test suite, check out the new release, run `make build_libqpdf`, check out the old release, and run `make check NO_REBUILD=1`.
 * When making a release, always remember to run large file tests and image comparison tests (`--enable-test-compare-images` `--with-large-file-test-path=/path`). For Windows, use a Windows style path, not an MSYS path for large files. For a major release, consider running a spelling checker over the source code to catch errors in variable names, strings, and comments. Use `ispell -p ispell-words`.
 * Run tests with sanitize address enabled:
   ```
@@ -24,7 +24,7 @@ For Windows, there are several additional files that you might want to download.
  
 * `qpdf-external-libs-src.zip`
  
-  If you want to build the external libraries on your own (for Windows or anything else), you can download this archive. In addition to including an unmodified distribution `zlib` and the `jpeg` libary, it includes a `README` file and some scripts to help you build it for Windows. You will also have to provide those.
+  If you want to build the external libraries on your own (for Windows or anything else), you can download this archive. In addition to including an unmodified distribution `zlib` and the `jpeg` library, it includes a `README` file and some scripts to help you build it for Windows. You will also have to provide those.
  
 If you want to build on Windows, please see also README-windows.md in the qpdf source distribution.
  
@@ -104,4 +104,4 @@ Redistribution of the runtime DLL is unavoidable as of this writing; see &quot;Static
  
 # Static Runtime
  
-Building the DLL and executables with static runtime does not work with either Visual C++ .NET 2008 (a.k.a. vc9) using `/MT` or with mingw (at least as of 4.4.0) using `-static-libgcc`.  The reason is that, in both cases, there is static data involved with exception handling, and when the runtime is linked in statically, exceptions cannot be thrown across the DLL to EXE boundary.  Since qpdf uses exception handling extensively for error handling, we have no choice but to redistribute the C++ runtime DLLs.  Maybe this will be addressed in a future version of the compilers.  This has not been retested with the toolchain versions used to create qpdf >= 3.0 distributions. This has not been revisited since MSVC 2008, but redistrbuting runtime DLLs is extremely common and should not be a problem.
+Building the DLL and executables with static runtime does not work with either Visual C++ .NET 2008 (a.k.a. vc9) using `/MT` or with mingw (at least as of 4.4.0) using `-static-libgcc`.  The reason is that, in both cases, there is static data involved with exception handling, and when the runtime is linked in statically, exceptions cannot be thrown across the DLL to EXE boundary.  Since qpdf uses exception handling extensively for error handling, we have no choice but to redistribute the C++ runtime DLLs.  Maybe this will be addressed in a future version of the compilers.  This has not been retested with the toolchain versions used to create qpdf >= 3.0 distributions. This has not been revisited since MSVC 2008, but redistributing runtime DLLs is extremely common and should not be a problem.
@@ -47,7 +47,7 @@ That code has the following license:
  
 # 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.md](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
+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.md](README-windows.md) for how to handle this.  For UNIX and UNIX-like systems, you must have some additional tools installed to build from the source repository.  To do this, you should run
  
 ```
 ./autogen.sh
@@ -113,7 +113,7 @@ if test &quot;x$qpdf_OS_SECURE_RANDOM&quot; = &quot;x1&quot;; then
   AC_LINK_IFELSE([AC_LANG_PROGRAM(
     [[#pragma comment(lib, "crypt32.lib")
      #include <windows.h>
-     #include <Wincrypt.h>
+     #include <wincrypt.h>
      HCRYPTPROV cp;]],
      [CryptAcquireContext(&cp, NULL, NULL, PROV_RSA_FULL, 0);]
      )],
 //
 // This is an example of creating a PDF file from scratch. It
 // illustrates use of several QPDF operations for creating objects and
-// streams. It also serves as an ullstration of how to use
+// streams. It also serves as an illustration of how to use
 // StreamDataProvider with different types of filters.
 //
  
@@ -402,7 +402,7 @@ class QPDF
     void showXRefTable();
  
     // Returns a list of indirect objects for every object in the xref
-    // table. Useful for discovering objects that are not otherwised
+    // table. Useful for discovering objects that are not otherwise
     // referenced.
     QPDF_DLL
     std::vector<QPDFObjectHandle> getAllObjects();
@@ -178,7 +178,7 @@ class QPDFWriter
     // compression. Note that compressing the resulting data with
     // DCTDecode again will accumulate loss, so avoid multiple
     // compression and decompression cycles. This is mostly useful for
-    // retreiving image data.
+    // retrieving image data.
     QPDF_DLL
     void setDecodeLevel(qpdf_stream_decode_level_e);
  
@@ -62,11 +62,14 @@ APIs
 appendable
 appendItem
 appendString
+arandom
 arg
 argc
+args
 argv
 arko
 arko's
+Arora
 ArtBox
 ascii
 asciiHex
@@ -96,6 +99,7 @@ atoi
 AuthEvent
 autobuilder
 autoconf
+autofiles
 autogen
 autoheader
 autolabel
@@ -129,6 +133,7 @@ BogusRandomDataProvider
 boldseq
 bookinfo
 bool
+BORLANDC
 bp
 brdp
 bs
@@ -144,6 +149,7 @@ buildrules
 bw
 bytesNeeded
 ca
+calc
 calculateHOutline
 calculateHPageOffset
 calculateHSharedObject
@@ -169,6 +175,7 @@ ced
 cerr
 cf
 cfea
+CFLAGS
 CFM
 ch
 ChangeLog
@@ -190,24 +197,32 @@ CHPageOffsetEntry
 CHSharedObject
 CHSharedObjectEntry
 CHSomething
+cin
+cinfo
 ciphertext
 cl
 classname
 clearPipelineStack
 cleartext
+CloseHandle
 closeObject
 cmath
 cmd
+cmyk
 codepage
 codepoint
+col
 ColorSpace
+colorspace
 com
 compareVersions
 compatbility
+CompressConfig
 computeDeterministicIDData
 concat
 Cond
 config
+conftest
 const
 contrib
 CopiedStreamDataProvider
@@ -222,6 +237,7 @@ cphe
 cplusplus
 CPPFLAGS
 cr
+CreateFile
 createPageContents
 createWhat
 CreationDate
@@ -242,13 +258,15 @@ cstring
 ctest
 ctx
 ctype
+cxx
+CXXFLAGS
 cygwin
 da
 daae
 dae
 db
 dc
-DCT
+dct
 DCTDecode
 dd
 ddaf
@@ -276,6 +294,9 @@ dereferenced
 dest
 DESTDIR
 detecet
+dev
+devel
+DeviceCMYK
 DeviceGray
 DeviceRGB
 dict
@@ -291,6 +312,7 @@ DiscardContents
 discardGeneration
 dist
 distclean
+dl
 dlfcn
 DLL
 DLL's
@@ -315,6 +337,7 @@ dup
 dwHighDateTime
 dwLowDateTime
 DWORD
+dwVolumeSerialNumber
 ea
 eadb
 earlychange
@@ -327,7 +350,7 @@ ecedd
 eded
 eeb
 eeee
-EF
+ef
 EFF
 efgh
 EI
@@ -353,6 +376,8 @@ endstream
 enqueue
 enqueueing
 enqueueObject
+enqueueObjectsPCLm
+enqueueObjectsStandard
 enqueuePart
 enqueues
 enqueuing
@@ -363,6 +388,7 @@ eod
 eof
 eol
 epub
+eq
 eraseItem
 Erdelsky's
 errno
@@ -387,6 +413,7 @@ ff
 ffff
 fflush
 fghij
+fh
 fi
 fI
 fIinfilename
@@ -401,7 +428,13 @@ filetrailer
 filterCompressedObjects
 findAndSkipNextEOL
 findAttachmentStreams
+findEndstream
+findFirst
+findHeader
+findLast
 findPage
+findSource
+findStartxref
 fIoptions
 fIoutfilename
 firstname
@@ -411,25 +444,30 @@ flate
 FlateDecode
 flattenPagesTree
 flattenScalarReferences
+Florian
 FMT
 fn
 fname
 fo
 fopen
 forcePDFVersion
+foreach
 fprintf
 fR
 fr
 fread
+fsanitize
 fseek
 fseeki
 fseeko
+fstream
 ftell
 ftelli
 ftello
 fullinfo
 fullpad
 func
+fweimer
 fwrite
 Gagic
 GajiÄ
@@ -440,6 +478,7 @@ generateHintStream
 generateID
 generateObjectStreams
 genok
+getAllObjects
 getAllPages
 getAllPagesInternal
 getArrayAsVector
@@ -465,11 +504,13 @@ getErrorCode
 getErrorMessage
 getExtensionLevel
 getFileChecksum
+GetFileInformationByHandle
 getFilename
 getFilePosition
 getFirstChar
 getGen
 getGeneration
+getHeight
 getHexDigest
 getId
 getInlineImageValue
@@ -544,6 +585,7 @@ getVal
 getValue
 getWarnings
 getWhoami
+getWidth
 GG
 ghostscript
 GhostScript
@@ -551,8 +593,13 @@ github
 glerbl
 glibc
 gm
+gmail
 GNUC
+gnuwin
 grayscale
+grep
+gsdnld
+gswin
 gt
 GUIs
 gz
@@ -572,6 +619,7 @@ hexkey
 hexkeylen
 hexstring
 hexstrings
+hf
 HGeneric
 hh
 HighPart
@@ -589,6 +637,7 @@ HSharedObjectEntry
 HSi
 HSomething
 HSomethingEntry
+htcondor
 htm
 html
 http
@@ -602,6 +651,8 @@ ifdef
 ifeq
 iff
 ifndef
+ifstream
+ijg
 Im
 ImageC
 ImageChecker
@@ -626,6 +677,7 @@ initializeWithRandomBytes
 inline
 InlineImage
 inlineimage
+ino
 inode
 inpdf
 inputLen
@@ -647,6 +699,7 @@ inverter
 io
 IOLBF
 iomanip
+ios
 iostream
 irdp
 isArray
@@ -674,13 +727,26 @@ isScalar
 isspace
 isStream
 isString
+istream
 istype
 italicseq
 itemizedlist
 iter
 ith
+JCS
+JDIMENSION
+jerr
 Jian
 jklmnopqrstuvwxyz
+jmp
+jmpbuf
+JMSG
+jpeg
+jpeglib
+JPOOL
+JSAMPARRAY
+JSAMPLE
+JSAMPROW
 keybits
 keylen
 KEYLENGTH
@@ -698,11 +764,15 @@ len
 lengthNextN
 Lexer
 lhs
+libclang
 libgcc
+libjpeg
+LibJpeg
 libqpdf
 libs
 libtests
 libtiff
+LibTiff
 libtool
 libtool's
 libtoolize
@@ -722,8 +792,11 @@ linp
 LinParameters
 linux
 listitem
+ljpeg
 ll
 lld
+llvm
+longjmp
 lookup
 lossy
 LowPart
@@ -753,7 +826,7 @@ mdash
 MDd
 mediabox
 MediaBox
-MEM
+mem
 Memcheck
 memchr
 memcmp
@@ -762,6 +835,7 @@ memmove
 memset
 merchantability
 metadata
+mgr
 min
 mingw
 MinGW
@@ -771,6 +845,7 @@ misc
 MixColumn
 mk
 mkinstalldirs
+mklink
 monoseq
 MSC
 msg
@@ -779,6 +854,7 @@ MSVC&#39;s
 msys
 multibyte
 multiline
+multipage
 multithreaded
 Mutator
 mutators
@@ -809,6 +885,8 @@ newReal
 newReserved
 newStream
 newString
+nFileIndexHigh
+nFileIndexLow
 nfirst
 nitems
 nl
@@ -843,6 +921,7 @@ ObjAccessor
 ObjCache
 ObjCopier
 OBJDIR
+objdump
 ObjectHolder
 ObjGen
 ObjGens
@@ -881,6 +960,7 @@ ou
 OUE
 ous
 outbuf
+outbuffer
 OUTDOC
 outfile
 outfilename
@@ -891,6 +971,7 @@ outprefix
 outputLengthNextN
 ovecsize
 ovector
+pacman
 padLen
 Paeth
 pagemode
@@ -902,16 +983,21 @@ para
 param
 params
 parms
+parsecontent
 parseContentStream
 parseInternal
 ParserCallbacks
 parseVersion
 partLen
 pathsep
+patmv
+PatternFinder
 Pavlyuk
 pb
 pbytes
 pc
+PCLm
+pclm
 pcre
 pdf
 PDFâ
@@ -997,8 +1083,10 @@ qpdf&#39;s
 QPDF's
 QPDFCONSTANTS
 QPDFExc
+QPDFFake
 QPDFObject
 QPDFObjectHandle
+QPDFObjectHandle's
 QPDFObjectHandles
 QPDFObjectTypeAccessor
 QPDFObjGen
@@ -1022,6 +1110,7 @@ qtest
 QTest
 QuadPart
 QUtil
+qutil
 qwert
 rand
 RandomDataProvider
@@ -1045,6 +1134,7 @@ readObjectAtOffset
 readToken
 reattached
 recompress
+recompressed
 recompressing
 recomputation
 recoverStreamLength
@@ -1071,11 +1161,13 @@ reserveObjects
 resetBits
 resolveLiteral
 resolveObjectsInStream
+ResolveRecorder
 retargeted
 retested
 reverseResolved
 rf
 rfont
+rgb
 rhs
 rijndael
 rijndaelDecrypt
@@ -1085,18 +1177,29 @@ rijndaelSetupEncrypt
 rk
 Rkey
 RKLENGTH
-RL
+rl
 rm
 RNRT
+rotatePage
+RotationSpec
 roundoff
+rr
 RSA
+rspec
 rstream
 RStream
+RunLength
+runlength
 RunLengthDecode
 runtest
+Sahil
+sahilarora
 sAlT
-SAPHIR
+saphir
+sarray
 SASLprep
+scanline
+scanlines
 se
 SecureRandomDataProvider
 sed
@@ -1109,8 +1212,10 @@ setArrayFromVector
 setArrayItem
 setAttemptRecovery
 setbase
+setCompressStreams
 setContentNormalization
 setDataKey
+setDecodeLevel
 setDeterministicID
 setEncryptionParameters
 setEncryptionParametersInternal
@@ -1121,12 +1226,14 @@ setFromVector
 setIgnoreXRefStreams
 setItem
 setIV
+setjmp
 setLastObjectDescription
 setLastOffset
 setLinearization
 setLineBuf
 setMinimumPDFVersion
 setmode
+setNewlineBeforeEndstream
 setO
 setObjectStreamMode
 setObjGen
@@ -1135,8 +1242,10 @@ setOutputFilename
 setOutputMemory
 setOutputPipeline
 setOutputStreams
+setPCLm
 setprecision
 setPreserveEncryption
+setPreserveUnreferencedObjects
 setQDFMode
 setR
 setRandomDataProvider
@@ -1149,6 +1258,7 @@ setTrailer
 setU
 setV
 setvbuf
+sf
 sha
 shallowCopy
 showLinearizationData
@@ -1156,10 +1266,13 @@ showXRefTable
 sizeof
 skipToNextByte
 soe
+softlink
 sourceforge
 SourceForge
 sph
+sphlib
 sprintf
+sqlite
 srand
 srandom
 src
@@ -1178,16 +1291,19 @@ stdin
 stdint
 StdioFile
 stdlib
+stdlib's
 stdout
 STL
 StmF
 str
+strcasecmp
 strchr
 strcmp
 strcpy
 StreamDataProvider
 strerror
 StrF
+stricmp
 StringDecrypter
 stringprep
 stripesize
@@ -1210,6 +1326,7 @@ Subramanyam
 substr
 substring
 Subtype
+sudo
 supp
 suppressions
 swapObjects
@@ -1219,6 +1336,7 @@ sys
 sysnow
 SYSTEMTIME
 SystemTimeToFileTime
+Syuu
 TARNAME
 tbuf
 tc
@@ -1239,6 +1357,7 @@ tobj
 tobjid
 TODO
 toffset
+tokenize
 tokenized
 tokenizer
 tokenizing
@@ -1250,6 +1369,7 @@ tp
 TrimBox
 trimTrailerForWrite
 tt
+turbo
 txt
 uc
 udata
@@ -1288,6 +1408,7 @@ updateAllPagesCache
 updateObjectMaps
 updateObjectMapsInternal
 updatePagesCache
+urandom
 url
 UseOutlines
 useStaticIV
@@ -1319,10 +1440,11 @@ vp
 vvv
 wb
 Wconversion
+Weimer
 werror
 whoami
 WinAnsiEncoding
-Wincrypt
+wincrypt
 WindowsCryptProvider
 Wold
 writeBinary
@@ -1357,9 +1479,11 @@ xABUL
 xbebfbc
 xbf
 xc
+xcc
 xD
 xDC
 xeaa
+xee
 xefcdab
 xF
 xf
@@ -1384,6 +1508,8 @@ xpacket
 xpdf
 XRef
 xref
+xrefEntry
+xrefFirst
 XRefStm
 xrefStream
 xrefTable
@@ -957,7 +957,7 @@ QPDFObjectHandle::parseInternal(PointerHolder&lt;InputSource&gt; input,
                                 bool content_stream)
 {
     // This method must take care not to resolve any objects. Don't
-    // check the tpye of any object without first ensuring that it is
+    // check the type of any object without first ensuring that it is
     // a direct object. Otherwise, doing so may have the side effect
     // of reading the object and changing the file pointer.
  
@@ -3261,7 +3261,7 @@ QPDFWriter::writeStandard()
         enqueueObjectsStandard();
     }
  
-    // Now start walking queue, outputing each object. There shouldn't
+    // Now start walking queue, outputting each object. There shouldn't
     // really be any here, but this will catch anything that somehow
     // got missed.
     while (this->m->object_queue.size())
@@ -1154,7 +1154,7 @@ static void read_args_from_file(char const* filename,
     }
 }
  
-static void handle_help_verison(int argc, char* argv[])
+static void handle_help_version(int argc, char* argv[])
 {
     if ((argc == 2) &&
         ((strcmp(argv[1], "--version") == 0) ||
@@ -2255,7 +2255,7 @@ int main(int argc, char* argv[])
 	whoami += 3;
     }
  
-    handle_help_verison(argc, argv);
+    handle_help_version(argc, argv);
  
     // Support reading arguments from files. Create a new argv. Ensure
     // that argv itself as well as all its contents are automatically