From owner-svn-doc-all@FreeBSD.ORG Sun May 25 13:38:22 2014 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id EC66682D; Sun, 25 May 2014 13:38:21 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id D887E20F0; Sun, 25 May 2014 13:38:21 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s4PDcLlR062365; Sun, 25 May 2014 13:38:21 GMT (envelope-from bcr@svn.freebsd.org) Received: (from bcr@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s4PDcLga062364; Sun, 25 May 2014 13:38:21 GMT (envelope-from bcr@svn.freebsd.org) Message-Id: <201405251338.s4PDcLga062364@svn.freebsd.org> From: Benedict Reuschling Date: Sun, 25 May 2014 13:38:21 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r44948 - head/en_US.ISO8859-1/articles/p4-primer X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 25 May 2014 13:38:22 -0000 Author: bcr Date: Sun May 25 13:38:21 2014 New Revision: 44948 URL: http://svnweb.freebsd.org/changeset/doc/44948 Log: - Remove redundant markup and words for "command". - Capitalize titles. - Remove contractions. Next up: whitespace fixes. Modified: head/en_US.ISO8859-1/articles/p4-primer/article.xml Modified: head/en_US.ISO8859-1/articles/p4-primer/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/p4-primer/article.xml Sun May 25 13:07:57 2014 (r44947) +++ head/en_US.ISO8859-1/articles/p4-primer/article.xml Sun May 25 13:38:21 2014 (r44948) @@ -51,8 +51,8 @@ Reading the Perforce User's Guide and Perforce Command Reference is highly recommended. The p4 application also contains an - extensive amount of online help accessible via the p4 - help command. + extensive amount of online help accessible via p4 + help. The &os; Perforce server is hosted on perforce.freebsd.org, @@ -127,9 +127,9 @@ lives on. Thus, working on multiple machines requires that multiple clients be used. - Clients may be accessed via the p4 client - command. Running this command with no arguments will bring up a - client template in an editor, allowing you to create a new client + Clients may be accessed via p4 client. + Running this command with no arguments will bring up a client + template in an editor, allowing you to create a new client for your work. The important fields in this template are explained below: @@ -218,8 +218,9 @@ this directory and all files and directories below it. - A Perforce view can contain multiple mappings. Let's say you - want to map in both the SMPng tree and the NFS tree. Your + A Perforce view can contain multiple + mappings. Say you want to map in both the SMPng tree and + the NFS tree. Your View might look like: //depot/projects/smpng/... //client/smpng/... @@ -246,10 +247,10 @@ - Existing clients can be listed via the p4 - clients command. They can be viewed without being - modified via the p4 client -o - clientname command. + Existing clients can be listed via p4 + clients. They can be viewed without being + modified via p4 client -o + clientname. Whenever you are interacting with files in Perforce, the P4CLIENT @@ -271,7 +272,7 @@ Once you have a client specification defined and the P4CLIENT variable set, the next step is to pull the files for that client down to your local machine. This is done - with the p4 sync command, which instructs + with p4 sync, which instructs Perforce to synchronize the local files in your client with the repository. The first time it runs, it 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 until you populate it. - To populate your branch, first edit your client with the - p4 client command and make sure that the branch + To populate your branch, first edit your client with + p4 client and make sure that the branch directory is mapped in your client. You might need to add a View line like: //depot/projects/my-new-project/... //myclient/my-new-project/... - The next step is to run the p4 integrate - command, as described in the next section. + The next step is to run p4 integrate, as + described in the next section. @@ -422,7 +423,7 @@ will instruct Perforce to look for 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 - 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 simply be copied to the child location on the local machine. @@ -446,8 +447,8 @@ possible conflict and resolve it by hand if needed. Once all of the integrated files have been resolved, they need - to be committed back to the repository. This is done via the - p4 submit command, explained in the next + to be committed back to the repository. This is done via + p4 submit, explained in the next section. @@ -456,8 +457,8 @@ Changes that are made locally should be committed back to the Perforce server for safe keeping and so - that others can access them. This is done via the p4 - submit command. When you run this command, it will open + that others can access them. This is done via p4 + submit. When you run this command, it will open up a submit template in an editor. &os; has a custom template, and the important fields are described below: @@ -515,8 +516,8 @@ for edit, and uses this to help with submit, sync, and integration operations later on. - To open a file for editing, use the p4 edit - command like so: + To open a file for editing, use p4 edit + like so: &prompt.user; p4 edit filename @@ -526,7 +527,7 @@ operation. Note that editing is not exclusive in Perforce. Multiple people can have the same file in the edit state (you will be informed of others when - you run the edit command), and you can submit + you run edit), and you can submit your changes even when others are still editing the file. When someone else submits a change to a file that you are @@ -539,8 +540,8 @@ changes to the repository. 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 - p4 revert command like so: + your changes and revert it to its original state, run + p4 revert like so: &prompt.user; p4 revert filename @@ -554,8 +555,8 @@ filesystem. When you tell the server to open it for editing, it is changed to read-write on the filesystem. While these permissions can easily be overridden by hand, they are meant to - gently remind you that you should being using the p4 - edit command. Files that have local changes but are not + gently remind you that you should being using p4 + edit. Files that have local changes but are not in the edit state may get overwritten when doing a p4 sync. @@ -564,14 +565,14 @@ Changes, Descriptions, and History Changes to the Perforce depot can - be listed via the p4 changes command. This + be listed via p4 changes. This will provide a brief description of each change, who made the change, and what its change number was. A change can be examined - in detail via the p4 describe - changenumber command. This + in detail via command>p4 describe + changenumber. This will provide the submit log and the diffs of the actual change. - Commonly, the p4 describe command is used in one + Commonly, p4 describe is used in one of three ways: @@ -610,10 +611,9 @@ - The p4 filelog - filename command will show - the history of a file, including all submits, integrations, and - branches of it. + The history of a file, including all submits, integrations, + and branches of it will be shown by p4 filelog + filename. @@ -665,7 +665,7 @@ format that is slightly incompatible with the traditional Unix diff and patch tools. Using the P4DIFF variable to point to the real &man.diff.1; tool can help this, but only for - the p4 diff command. The output of + p4 diff. The output of command must be post-processed to be useful (the flag of will produce unified diffs that are somewhat compatible, but it does @@ -679,7 +679,7 @@ Integrating a branch will bring existing files into your tree, 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 - the p4 add command like so: + p4 add like so: &prompt.user; p4 add filename @@ -692,7 +692,7 @@ Perforce can track UNIX symlinks too, so you can probably use \! -type d 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 necessary. @@ -716,14 +716,14 @@ the repository. Deleted files can be resurrected by syncing them to a prior - version. The only way to permanently remove a file is to use the - p4 obliterate command. This command is + version. The only way to permanently remove a file is to use + p4 obliterate. This command is irreversible and expensive, so it is only available to those with admin access. - Working with diffs + Working with Diffs Sometimes you might need to apply a diff from another source to a tree under Perforce control. If @@ -759,7 +759,7 @@ - Renaming files + Renaming Files Perforce does not have a built-in way of renaming files or moving them to a different part of the @@ -787,7 +787,7 @@ - Interactions between &os; Subversion and Perforce + Interactions Between &os; Subversion and Perforce The &os; Perforce and Subversion repositories are completely separate. However, changes to Subversion are