motiejus
/
jgit
1
Fork 0
Code Releases Activity

Merge "Document new PackWriter#preparePack variant's parameters and exceptions"

This commit is contained in:
Jonathan Nieder 2016-08-08 19:55:57 -04:00 committed by Gerrit Code Review @ Eclipse.org
parent 6ccc7992d4 f28de24fa8
commit 22f24e7df2
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackWriter.java
View File

@ -723,6 +723,26 @@ public void preparePack(ProgressMonitor countingMonitor,
* be shallow any more ("unshallow" commits as in {@link #setShallowPack})
* from the shallow set.
*
* @param countingMonitor
* progress during object enumeration.
* @param want
* objects of interest, ancestors of which will be included in
* the pack. Must not be {@code null}.
* @param have
* objects whose ancestors (up to and including
* {@code shallow} commits) do not need to be included in the
* pack because they are already available from elsewhere.
* Must not be {@code null}.
* @param shallow
* commits indicating the boundary of the history marked with
* {@code have}. Shallow commits have parents but those
* parents are considered not to be already available.
* Parents of {@code shallow} commits and earlier generations
* will be included in the pack if requested by {@code want}.
* Must not be {@code null}.
* @param IOException
* an I/O problem occured while reading objects.
*
* @since 4.5
*/
public void preparePack(ProgressMonitor countingMonitor,