RepositoryGetFileAnnotations Method |
Return FileAnnotation objects for the listed FileSpecs.
Namespace: Perforce.P4
Assembly: p4api.net (in p4api.net.dll) Version: 2023.2.258.5793
Syntaxpublic IList<FileAnnotation> GetFileAnnotations( IList<FileSpec> filespecs, Options options )
Parameters
- filespecs
- Type: System.Collections.GenericIListFileSpec
- options
- Type: Perforce.P4Options
Return Value
Type: IListFileAnnotationRemarksp4 help annotate
annotate -- Print file lines and their revisions
p4 annotate [-aciIqt -d<flags>] file[revRange] ...
Prints all lines of the specified files, indicating the revision that
introduced each line into the file.
If the file argument includes a revision, then only revisions up to
the specified revision are displayed. If the file argument has a
revision range, only revisions within that range are displayed. For
details about specifying revisions, see 'p4 help revisions'.
The -a flag includes both deleted files and lines no longer present
at the head revision. In the latter case, both the starting and ending
revision for each line is displayed.
The -c flag directs the annotate command to output changelist numbers
rather than revision numbers for each line.
The -d<flags> change the way whitespace and/or line endings are
treated: -db (ignore whitespace changes), -dw (ignore whitespace),
-dl (ignore line endings).
The -i flag follows branches. If a file was created by branching,
'p4 annotate' includes the revisions of the source file up to the
branch point, just as 'p4 filelog -i' does. If a file has history
prior to being created by branching (such as a file that was branched
on top of a deleted file), -i ignores those prior revisions and
follows the source. -i implies -c.
The -I flag follows all integrations into the file. If a line was
introduced into the file by a merge, the source of the merge is
displayed as the changelist that introduced the line. If the source
itself was the result of an integration, that source is used instead,
and so on. -I implies -c and may not be combined with -i.
The -q flag suppresses the one-line header that is displayed by
default for each file.
The -t flag forces 'p4 annotate' to display binary files.
Examples
To get the file annotations of the file //depot/MyCode/README.txt:
To get the file annotations of the file //depot/MyCode/README.txt redirecting the
contents to local file C:\Doc\README.txt and supressing the one-line header:
GetFileAnnotationsCmdOptions opts = new GetFileAnnotationsCmdOptions(GetFileAnnotationsCmdFlags.None, null); FileSpec filespec = new FileSpec(new DepotPath("//depot/MyCode/README.txt"), null); IList<FileSpec> filespecs = new List<FileSpec>(); filespecs.Add(filespec); IList<FileAnnotation> target = Repository.GetFileAnnotations(filespecs, opts);
GetFileAnnotationsCmdOptions opts = new GetFileAnnotationsCmdOptions(GetFileAnnotationsCmdFlags.Suppress, "C:\\Doc\\README.txt"); FileSpec filespec = new FileSpec(new DepotPath("//depot/MyCode/README.txt"), null); IList<FileSpec> filespecs = new List<FileSpec>(); filespecs.Add(filespec); IList<FileAnnotation> target = Repository.GetFileAnnotations(filespecs, opts);
See Also