sync.html #1

  • //
  • guest/
  • perforce_software/
  • p4web/
  • main/
  • src/
  • Help/
  • sync.html
  • View
  • Commits
  • Open Download .zip Download (5 KB)
<TITLE>Syncing Files</TITLE>

<p> The Perforce <b>sync</b> command synchronizes your workspace files with the 
  files in the depot. Syncing uses your client spec to determine which depot files 
  to get and where to put them in your workspace. To look at or edit your client 
  spec, click your client name at the top of any screen in P4Web . 
<p> If there are files in the depot that haven't been copied to your workspace, 
  <b>sync</b> copies them in. If any the depot files have been updated, <b>sync</b> 
  copies the newer files to your workspace. If you have files in your workspace 
  that have been deleted in the depot, or if you have changed your client mapping 
  so that files you previously synced are no longer in your client view, <b>sync</b> 
  removes those files from your workspace. If your workspace files are already 
  up to date with the depot, syncing does nothing. 
<p>
The
"<img src="/synced?icon">" and
"<img src="/syncednone?icon">" icons mark workspace
files that are in sync with existing and deleted depot files,
respectively.
The "<img src="/sync?icon">" icon marks files that are
not in sync with head revisions in the depot.
If you have "Show entire depot" set,
files previously synced but no longer mapped in your client
view are marked with "<img src="/unmapped?icon">".

<p> If you have files open for edit or integrate, syncing does not remove or copy 
  over them. However, you won't be able to submit your open files until you've 
  <a href="resolve?help">resolved</a> changes from the newer files in the depot. 
  After you sync open files, they are marked with the "<img src="/resolve?icon">" 
  icon to remind you they need to be resolved. 
<p> Normally files synced to your workspace are read-only. Use <a href="edit?help">open 
  for edit</a> to make them writable. 
<p> To sync files: 
<p>
<ul>
  <li>Select <b>Sync...</b> from the <b>Action</b> menu at the top of the <B>Files</B> 
    tab. P4Web displays the <a href="sync?help#options">Sync Options</a> page 
    where you can pick options and preview or run the the <b>sync</b> command. 
  </li>
  <li>Click the <b>Sync to head revision</b> shortcut button. This shortcut syncs 
    the current path or file and syncs to head revisions without offering you 
    any options. </li>
</ul>
  <p> <img src="/runsync?icon" alt="Sync to Head Revisions"> <b>Sync to head revision</b> 
    shortcut button </p>
<a name=options></a> <b>The Sync Options Page</b> 
<p> The Sync Options page lets you pick from these options before previewing or 
  running the <b>sync</b> command: 
<table width="66%" border="1" cellpadding="1">
  <tr>
    <td><b>Head revision</b></td>
    <td><b>Sync</b> to the head revisions (latest versions). </td>
  </tr>
  <tr>
    <td><b>Revision number</b></td>
    <td><b>Sync</b> to a specified revision.</td>
  </tr>
  <tr>
    <td><b>Changelist Number</b></td>
    <td><b>Sync</b> to a specified changelist number. Enter the changelist number 
      in the space provided. Syncing to a changelist number gets files that were 
      the head revisions in the depot at the time the changelist was submitted. 
    </td>
  </tr>
  <tr>
    <td><b>Label or Date</b></td>
    <td><b>Sync</b> to a specific symbolic revision revision (either a label or 
      date). Enter the label or date in the space provided. </td>
  </tr>
  <tr>
    <td>
      <p> 
      <dl>
        <dt><b>Same Revision</b></dt>
      </dl>
    </td>
    <td> <b>Sync</b> to the same revisions you already have in your workspace. 
    </td>
  </tr>
  <tr>
    <td><b>Force</b></td>
    <td>Gets fresh copies of files from the depot, even if the Perforce server 
      thinks you already have those files. Use this option to replace files that 
      were manually removed from your workspace. </td>
  </tr>
</table>

  
  
<p> If you came to the <b>Sync Options page</b> with a directory selected, you 
  can <a href="restrictfiles?help">restrict</a> the files to be opened. Regardless 
  of which files you select, a file is only synced to your workspace if: 
<p> 
  <ul>
    <li>The file is not already opened in your workspace 
    <li>The file is in your client view 
    <li>You have permission to read the file 
  </ul>


<h3>Syncing and submitting from remote machines</h3>
<p>P4Web mediates between a Web browser and a Perforce server. You can run P4Web 
  on a machine that is separate from both the browser and server machines. When 
  using P4Web remotely, the important thing to understand is that <b>your workspace 
  resides on the machine where P4Web is running</b>, and <i>not</i> the machine 
  where the browser is running. 
<p>P4Web enables you to edit text files directly in your browser, even when P4Web 
  is running on a remote machine. However, to edit binary files on a remote machine, 
  you must sync them, open them for edit, and then download them to your browser 
  machine. To submit edited files from a remote machine, you must upload them 
  to the workspace on the P4Web machine before submitting them. 
<p><b>Downloading and uploading binary files: </b>
<ul>
  <li> To download a file from the P4Web machine, right-click its link on the 
    <b>Revision History</b> page and choose your browser's <b>Save</b> option 
    (for example, <b>Save Target As...</b>) </li>
  <li>To upload a file to the P4Web machine, choose the <b>Upload File to Workspace</b> 
    option from the drop-down list on the <b>Revision History</b> page, browse 
    to the file you want to upload, then click <b>Upload</b>. </li>
</ul>
# Change User Description Committed
#1 12234 Matt Attaway Rejigger P4Web project in preparation for official sunsetting

The bin directory contains the last official builds of P4Web from the
Perforce download site. P4Web is soon to be completely sunsetted; these
builds are here for folks who don't want to build their own.

To better handle the archived builds the source code has been moved into
a separate src directory.
//guest/perforce_software/p4web/Help/sync.html
#1 8914 Matt Attaway Initial add of the P4Web source code