Jakob Heher created PDFBOX-6230:
-----------------------------------

             Summary: Documentation is misleading/outdated around incremental 
writing
                 Key: PDFBOX-6230
                 URL: https://issues.apache.org/jira/browse/PDFBOX-6230
             Project: PDFBox
          Issue Type: Bug
          Components: PDModel
    Affects Versions: 3.0.8 PDFBox
            Reporter: Jakob Heher


The documentation on 
[PDDocument::saveIncremental|https://javadoc.io/static/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/PDDocument.html#saveIncremental-java.io.OutputStream-]
 and 
[COSWriter::COSWriter|https://javadoc.io/static/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdfwriter/COSWriter.html#COSWriter-java.io.OutputStream-org.apache.pdfbox.io.RandomAccessRead-]
 specifies:
{quote}There must be a path of objects that have 
[{{COSUpdateInfo.isNeedToBeUpdated()}}|https://javadoc.io/static/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/cos/COSUpdateInfo.html#isNeedToBeUpdated--]
 set, starting from the document catalog.
{quote}
 

However, I believe this to be incorrect, since COSIncrement includes a 
(transitive) parent if there is a direct child (of a direct child of...) that 
requires an update: 
[https://github.com/apache/pdfbox/blob/3.0.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSIncrement.java#L114]

This was added in 
[https://github.com/apache/pdfbox/commit/23e85be12c8968cbb68ce99b6071f2a12bf7a5f4]
 in response to PDFBOX-5263, I believe.

Was the documentation update simply missed here, or is there something I am 
missing?



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to