reftable: add some more comments

Change-Id: I95208f7a05919b5019895cf41ae378c97da6e680
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
This commit is contained in:
Han-Wen Nienhuys 2019-08-19 11:25:58 +02:00
parent ca9107d166
commit ca3b4b6083
2 changed files with 18 additions and 4 deletions

View File

@ -84,7 +84,11 @@
import org.eclipse.jgit.util.NB;
import org.eclipse.jgit.util.RawParseUtils;
/** Reads a single block for {@link ReftableReader}. */
/**
* Reads a single block for {@link ReftableReader}. Instances are tied to a
* specific block in the file so are not reused for other blocks. Instances hold
* an offset into the block.
*/
class BlockReader {
private byte blockType;
private long endPosition;
@ -141,6 +145,8 @@ String name() {
return RawParseUtils.decode(UTF_8, nameBuf, 0, len);
}
// Matches the key against a name or a prefix. For reflogs, only the
// refname is matched, and the updateIndex suffix is ignored.
boolean match(byte[] match, boolean matchIsPrefix) {
int len = nameLen;
if (blockType == LOG_BLOCK_TYPE) {

View File

@ -256,8 +256,8 @@ private BlockReader seek(byte blockType, byte[] key, BlockReader idx,
return block;
}
if (blockType == LOG_BLOCK_TYPE) {
// No index. Log blocks are irregularly sized, so we can't do binary search
// between blocks. Scan over blocks instead.
// No index. Log blocks are irregularly sized, so we can't do binary
// search between blocks. Scan over blocks instead.
BlockReader block = readBlock(startPos, endPos);
for (;;) {
@ -555,12 +555,20 @@ public void close() {
private class LogCursorImpl extends LogCursor {
private final long scanEnd;
private final byte[] match;
private String refName;
private long updateIndex;
private ReflogEntry entry;
BlockReader block;
/**
* Scans logs from this table until scanEnd position.
*
* @param scanEnd
* end of the log data in the reftable.
* @param match
* if non-null, limits the scan to precisely that refname.
*/
LogCursorImpl(long scanEnd, byte[] match) {
this.scanEnd = scanEnd;
this.match = match;