.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Git::Raw::Indexer 3pm" .TH Git::Raw::Indexer 3pm "2022-10-29" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Git::Raw::Indexer \- Git indexer class .SH "VERSION" .IX Header "VERSION" version 0.90 .SH "DESCRIPTION" .IX Header "DESCRIPTION" A Git::Raw::Indexer represents a git indexer object. .SH "METHODS" .IX Header "METHODS" .ie n .SS "new( $directory, $odb )" .el .SS "new( \f(CW$directory\fP, \f(CW$odb\fP )" .IX Subsection "new( $directory, $odb )" Create a new indexer. \f(CW$directory\fR is the directory where the packfile and index should be stored. .ie n .SS "append( $data, $progress )" .el .SS "append( \f(CW$data\fP, \f(CW$progress\fP )" .IX Subsection "append( $data, $progress )" Add \f(CW$data\fR to the indexer. \f(CW$progress\fR should be a Git::Raw::TransferProgress object. .ie n .SS "commit( $progress )" .el .SS "commit( \f(CW$progress\fP )" .IX Subsection "commit( $progress )" Finalize the pack and index. This will resolve any pending deltas and write out the index file. \f(CW$progress\fR should be a Git::Raw::TransferProgress object. .SS "hash( )" .IX Subsection "hash( )" Retrieve the packfile's hash. A packfile's name is derived from the sorted hashing of all object names. This is only correct after the index has been finalized. .SH "AUTHOR" .IX Header "AUTHOR" Jacques Germishuys .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright 2016 Jacques Germishuys. .PP This program is free software; you can redistribute it and/or modify it under the terms of either: the \s-1GNU\s0 General Public License as published by the Free Software Foundation; or the Artistic License. .PP See http://dev.perl.org/licenses/ for more information.