Click or drag to resize

Options Constructor (DescribeChangelistCmdFlags, Int32, Int32)

Options for the Describe command

Namespace:  Perforce.P4
Assembly:  p4api.net (in p4api.net.dll) Version: 2023.2.255.3501
Syntax
public Options(
	DescribeChangelistCmdFlags flags,
	int contextLines,
	int unifiedLines
)

Parameters

flags
Type: Perforce.P4DescribeChangelistCmdFlags
contextLines
Type: SystemInt32
unifiedLines
Type: SystemInt32
Remarks

p4 help describe

describe -- Display a changelist description

p4 describe [-d<flags> -m -s -S -f -O] changelist# ...

Display a changelist description, including the changelist number,
user, client, date of submission, textual description, list of
affected files and diffs of files updated. Pending changelists
are indicated as 'pending' and file diffs are not displayed.

For restricted changelists, 'no permission' is displayed if the user
is not permitted to view the change (see 'p4 help change'). If a
submitted change is restricted, the description is hidden unless
the user is the owner of the change or has list permission for
at least one file in the change. If a shelved change is restricted,
the description is hidden unless the user is the owner of the change,
or has list permission to at least one file in the change and has
used the -S flag to request the shelved change. To view restricted
pending (not shelved) changes, the user must be the owner of the
change.

The -d<flags> passes one or more flags to the built-in diff routine
to modify the output: -dn (RCS), -dc[n] (context), -ds (summary),
-du[n] (unified), -db (ignore whitespace changes), -dw (ignore
whitespace), -dl (ignore line endings). The optional argument to
to -dc/-du specifies number of context lines.

The -s flag omits the diffs of files that were updated.

The -S flag lists files that are shelved for the specified changelist
and displays diffs of the files against their previous revision.
If the change is restricted, the description is displayed according
to the rules for shelved restricted changes described above.

The -f flag forces display of the descriptions in a restricted
change. The -f flag requires 'admin' access, which is granted
using 'p4 protect'.

The -O flag specifies that the changelist number is the original
number of a changelist which was renamed on submit.

The -m flag limits files to the first 'max' number of files.

See Also