- Remove redundant markup and words for "command".

- Capitalize titles.
- Remove contractions.

Next up: whitespace fixes.
This commit is contained in:
Benedict Reuschling 2014-05-25 13:38:21 +00:00
parent 0d776fba4a
commit c8225e0713
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=44948

View file

@ -51,8 +51,8 @@
<para>Reading the <quote>Perforce User's Guide</quote> and <para>Reading the <quote>Perforce User's Guide</quote> and
<quote>Perforce Command Reference</quote> is highly recommended. <quote>Perforce Command Reference</quote> is highly recommended.
The <application>p4</application> application also contains an The <application>p4</application> application also contains an
extensive amount of online help accessible via the <command>p4 extensive amount of online help accessible via <command>p4
help</command> command.</para> help</command>.</para>
<para>The &os; <application>Perforce</application> server is <para>The &os; <application>Perforce</application> server is
hosted on <systemitem class="fqdomainname">perforce.freebsd.org</systemitem>, hosted on <systemitem class="fqdomainname">perforce.freebsd.org</systemitem>,
@ -127,9 +127,9 @@
lives on. Thus, working on multiple machines requires that lives on. Thus, working on multiple machines requires that
multiple clients be used.</para> multiple clients be used.</para>
<para>Clients may be accessed via the <command>p4 client</command> <para>Clients may be accessed via <command>p4 client</command>.
command. Running this command with no arguments will bring up a Running this command with no arguments will bring up a client
client template in an editor, allowing you to create a new client template in an editor, allowing you to create a new client
for your work. The important fields in this template are for your work. The important fields in this template are
explained below:</para> explained below:</para>
@ -218,8 +218,9 @@
<quote>this directory and all files and directories below <quote>this directory and all files and directories below
it.</quote></para> it.</quote></para>
<para>A Perforce <quote>view</quote> can contain multiple mappings. Let's say you <para>A Perforce <quote>view</quote> can contain multiple
want to map in both the SMPng tree and the NFS tree. Your mappings. Say you want to map in both the SMPng tree and
the NFS tree. Your
View might look like:</para> View might look like:</para>
<programlisting>//depot/projects/smpng/... //<replaceable>client</replaceable>/smpng/... <programlisting>//depot/projects/smpng/... //<replaceable>client</replaceable>/smpng/...
@ -246,10 +247,10 @@
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>Existing clients can be listed via the <command>p4 <para>Existing clients can be listed via <command>p4
clients</command> command. They can be viewed without being clients</command>. They can be viewed without being
modified via the <command>p4 client -o modified via <command>p4 client -o
<replaceable>clientname</replaceable></command> command.</para> <replaceable>clientname</replaceable></command>.</para>
<para>Whenever you are interacting with files in <para>Whenever you are interacting with files in
<application>Perforce</application>, the <envar>P4CLIENT</envar> <application>Perforce</application>, the <envar>P4CLIENT</envar>
@ -271,7 +272,7 @@
<para>Once you have a client specification defined and the <para>Once you have a client specification defined and the
<envar>P4CLIENT</envar> variable set, the next step is to pull the <envar>P4CLIENT</envar> variable set, the next step is to pull the
files for that client down to your local machine. This is done files for that client down to your local machine. This is done
with the <command>p4 sync</command> command, which instructs with <command>p4 sync</command>, which instructs
<application>Perforce</application> to synchronize the local files <application>Perforce</application> to synchronize the local files
in your client with the repository. The first time it runs, it in your client with the repository. The first time it runs, it
will download all of the files. Subsequent runs will only will download all of the files. Subsequent runs will only
@ -384,15 +385,15 @@
directory that you specified in the branch is empty on the server directory that you specified in the branch is empty on the server
until you populate it.</para> until you populate it.</para>
<para>To populate your branch, first edit your client with the <para>To populate your branch, first edit your client with
<command>p4 client</command> command and make sure that the branch <command>p4 client</command> and make sure that the branch
directory is mapped in your client. You might need to add a directory is mapped in your client. You might need to add a
<literal>View</literal> line like:</para> <literal>View</literal> line like:</para>
<programlisting>//depot/projects/my-new-project/... //<replaceable>myclient</replaceable>/my-new-project/...</programlisting> <programlisting>//depot/projects/my-new-project/... //<replaceable>myclient</replaceable>/my-new-project/...</programlisting>
<para>The next step is to run the <command>p4 integrate</command> <para>The next step is to run <command>p4 integrate</command>, as
command, as described in the next section.</para> described in the next section.</para>
</sect1> </sect1>
<sect1 xml:id="Integrations"> <sect1 xml:id="Integrations">
@ -422,7 +423,7 @@
will instruct <application>Perforce</application> to look for will instruct <application>Perforce</application> to look for
changes in the branch parent that are not yet in the child. From changes in the branch parent that are not yet in the child. From
those changes it will prepare a list of diffs to move. If the those changes it will prepare a list of diffs to move. If the
integration is being done for the first time on a branch (i.e. integration is being done for the first time on a branch (for example
doing an initial population operation), then the parent files will doing an initial population operation), then the parent files will
simply be copied to the child location on the local simply be copied to the child location on the local
machine.</para> machine.</para>
@ -446,8 +447,8 @@
possible conflict and resolve it by hand if needed.</para> possible conflict and resolve it by hand if needed.</para>
<para>Once all of the integrated files have been resolved, they need <para>Once all of the integrated files have been resolved, they need
to be committed back to the repository. This is done via the to be committed back to the repository. This is done via
<command>p4 submit</command> command, explained in the next <command>p4 submit</command>, explained in the next
section.</para> section.</para>
</sect1> </sect1>
@ -456,8 +457,8 @@
<para>Changes that are made locally should be committed back to the <para>Changes that are made locally should be committed back to the
<application>Perforce</application> server for safe keeping and so <application>Perforce</application> server for safe keeping and so
that others can access them. This is done via the <command>p4 that others can access them. This is done via <command>p4
submit</command> command. When you run this command, it will open submit</command>. When you run this command, it will open
up a submit template in an editor. &os; has a custom template, up a submit template in an editor. &os; has a custom template,
and the important fields are described below:</para> and the important fields are described below:</para>
@ -515,8 +516,8 @@
for edit, and uses this to help with submit, sync, and integration for edit, and uses this to help with submit, sync, and integration
operations later on.</para> operations later on.</para>
<para>To open a file for editing, use the <command>p4 edit</command> <para>To open a file for editing, use <command>p4 edit</command>
command like so:</para> like so:</para>
<screen>&prompt.user; <userinput>p4 edit <replaceable>filename</replaceable></userinput></screen> <screen>&prompt.user; <userinput>p4 edit <replaceable>filename</replaceable></userinput></screen>
@ -526,7 +527,7 @@
operation. Note that editing is not exclusive in operation. Note that editing is not exclusive in
<application>Perforce</application>. Multiple people can have the <application>Perforce</application>. Multiple people can have the
same file in the edit state (you will be informed of others when same file in the edit state (you will be informed of others when
you run the <command>edit</command> command), and you can submit you run <command>edit</command>), and you can submit
your changes even when others are still editing the file.</para> your changes even when others are still editing the file.</para>
<para>When someone else submits a change to a file that you are <para>When someone else submits a change to a file that you are
@ -539,8 +540,8 @@
changes to the repository.</para> changes to the repository.</para>
<para>If you have a file open for edit and you want to throw away <para>If you have a file open for edit and you want to throw away
your changes and revert it to its original state, run the your changes and revert it to its original state, run
<command>p4 revert</command> command like so:</para> <command>p4 revert</command> like so:</para>
<screen>&prompt.user; <userinput>p4 revert <replaceable>filename</replaceable></userinput></screen> <screen>&prompt.user; <userinput>p4 revert <replaceable>filename</replaceable></userinput></screen>
@ -554,8 +555,8 @@
filesystem. When you tell the server to open it for editing, it filesystem. When you tell the server to open it for editing, it
is changed to read-write on the filesystem. While these is changed to read-write on the filesystem. While these
permissions can easily be overridden by hand, they are meant to permissions can easily be overridden by hand, they are meant to
gently remind you that you should being using the <command>p4 gently remind you that you should being using <command>p4
edit</command> command. Files that have local changes but are not edit</command>. Files that have local changes but are not
in the edit state may get overwritten when doing a <command>p4 in the edit state may get overwritten when doing a <command>p4
sync</command>.</para> sync</command>.</para>
</sect1> </sect1>
@ -564,14 +565,14 @@
<title>Changes, Descriptions, and History</title> <title>Changes, Descriptions, and History</title>
<para>Changes to the <application>Perforce</application> depot can <para>Changes to the <application>Perforce</application> depot can
be listed via the <command>p4 changes</command> command. This be listed via <command>p4 changes</command>. This
will provide a brief description of each change, who made the will provide a brief description of each change, who made the
change, and what its change number was. A change can be examined change, and what its change number was. A change can be examined
in detail via the <command>p4 describe in detail via command>p4 describe
<replaceable>changenumber</replaceable></command> command. This <replaceable>changenumber</replaceable></command>. This
will provide the submit log and the diffs of the actual change.</para> will provide the submit log and the diffs of the actual change.</para>
<para>Commonly, the <command>p4&nbsp;describe</command> command is used in one <para>Commonly, <command>p4&nbsp;describe</command> is used in one
of three ways:</para> of three ways:</para>
<variablelist> <variablelist>
@ -610,10 +611,9 @@
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>The <command>p4 filelog <para>The history of a file, including all submits, integrations,
<replaceable>filename</replaceable></command> command will show and branches of it will be shown by <command>p4 filelog
the history of a file, including all submits, integrations, and <replaceable>filename</replaceable></command>.</para>
branches of it.</para>
</sect1> </sect1>
<sect1 xml:id="diffs"> <sect1 xml:id="diffs">
@ -665,7 +665,7 @@
format that is slightly incompatible with the traditional Unix format that is slightly incompatible with the traditional Unix
diff and patch tools. Using the <envar>P4DIFF</envar> variable to diff and patch tools. Using the <envar>P4DIFF</envar> variable to
point to the real &man.diff.1; tool can help this, but only for point to the real &man.diff.1; tool can help this, but only for
the <command>p4 diff</command> command. The output of <command>p4 diff</command>. The output of
<option>diff2</option> command must be post-processed to be useful <option>diff2</option> command must be post-processed to be useful
(the <option>-u</option> flag of <option>diff2</option> will (the <option>-u</option> flag of <option>diff2</option> will
produce unified diffs that are somewhat compatible, but it does produce unified diffs that are somewhat compatible, but it does
@ -679,7 +679,7 @@
<para>Integrating a branch will bring existing files into your tree, <para>Integrating a branch will bring existing files into your tree,
but you may still want to add new files or remove existing ones. but you may still want to add new files or remove existing ones.
Adding files is easily done be creating the file and then running Adding files is easily done be creating the file and then running
the <command>p4 add</command> command like so:</para> <command>p4 add</command> like so:</para>
<screen>&prompt.user; <userinput>p4 add <replaceable>filename</replaceable></userinput></screen> <screen>&prompt.user; <userinput>p4 add <replaceable>filename</replaceable></userinput></screen>
@ -692,7 +692,7 @@
<para><application>Perforce</application> can track UNIX symlinks too, so <para><application>Perforce</application> can track UNIX symlinks too, so
you can probably you can probably
use <quote><command>\!&nbsp;-type&nbsp;d</command></quote> as the use <quote><command>\!&nbsp;-type&nbsp;d</command></quote> as the
matching expression in &man.find.1; above. We don't commit symlinks matching expression in &man.find.1; above. We do not commit symlinks
into the source tree of &os; though, so this should not be into the source tree of &os; though, so this should not be
necessary.</para> necessary.</para>
</note> </note>
@ -716,14 +716,14 @@
the repository.</para> the repository.</para>
<para>Deleted files can be resurrected by syncing them to a prior <para>Deleted files can be resurrected by syncing them to a prior
version. The only way to permanently remove a file is to use the version. The only way to permanently remove a file is to use
<command>p4 obliterate</command> command. This command is <command>p4 obliterate</command>. This command is
irreversible and expensive, so it is only available to those with irreversible and expensive, so it is only available to those with
admin access.</para> admin access.</para>
</sect1> </sect1>
<sect1 xml:id="working-with-diffs"> <sect1 xml:id="working-with-diffs">
<title>Working with diffs</title> <title>Working with Diffs</title>
<para>Sometimes you might need to apply a diff from another source <para>Sometimes you might need to apply a diff from another source
to a tree under <application>Perforce</application> control. If to a tree under <application>Perforce</application> control. If
@ -759,7 +759,7 @@
</sect1> </sect1>
<sect1 xml:id="renaming-files"> <sect1 xml:id="renaming-files">
<title>Renaming files</title> <title>Renaming Files</title>
<para><application>Perforce</application> does not have a built-in <para><application>Perforce</application> does not have a built-in
way of renaming files or moving them to a different part of the way of renaming files or moving them to a different part of the
@ -787,7 +787,7 @@
</sect1> </sect1>
<sect1 xml:id="freebsd-cvs-and-p4"> <sect1 xml:id="freebsd-cvs-and-p4">
<title>Interactions between &os; Subversion and Perforce</title> <title>Interactions Between &os; Subversion and Perforce</title>
<para>The &os; <application>Perforce</application> and <application>Subversion</application> <para>The &os; <application>Perforce</application> and <application>Subversion</application>
repositories are completely separate. However, changes to Subversion are repositories are completely separate. However, changes to Subversion are