git-p4son 0.3.2__tar.gz → 0.3.4__tar.gz

{git_p4son-0.3.2 → git_p4son-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-p4son
-Version: 0.3.2
+Version: 0.3.4
 Summary: Utility for keeping a Perforce workspace and local git repo in sync
 Author-email: Andreas Andersson <andreas@neoboid.com>
 License-Expression: MIT
@@ -231,6 +231,14 @@ be managed manually or via Perforce directly.
 After syncing, git-p4son prints a summary of how each writable file was handled, and instructs you to review and
 commit any files that need attention.
 
+**Workspaces with `allwrite`** - When your client spec has the `allwrite` option, every file is writable by design,
+so the read-only flag carries no information about local changes. git-p4son classifies files exactly as above (the
+verdict comes from git, not from the flag), but leaves the write bit alone on files it finds unchanged: with
+`noclobber` Perforce compares digests before refusing to overwrite a writable file, and unchanged files pass that
+check. Only files with local changes are made read-only for the duration of the sync, since those are the ones
+Perforce would otherwise refuse to overwrite. The same digest check applies to git-ignored files: unchanged ones sync
+normally, and after the sync git-p4son lists the ones Perforce skipped because they were modified locally.
+
 ## Usage
 
 git-p4son provides nine commands: `init`, `sync`, `sync-split`, `new`, `update`, `review`, `list-changes`,
@@ -335,7 +343,10 @@ own submits one at a time. Repeat `--user` to split out several people's changel
 It is equivalent to working out the numbers by hand and running
 `git p4son sync <before-theirs> <theirs> ... head`, and it delegates to `sync` once the sequence is
 resolved, so [pre-sync and post-sync hooks](#hooks), writable-file merging, and the clean-workspace checks
-all behave exactly as they do for `sync`.
+all behave exactly as they do for `sync`. The clean-workspace checks and the pre-sync hooks are the one
+thing that runs earlier: resolving the sequence costs several Perforce queries, so they go first, and a
+dirty workspace or a hook that aborts the sync says so before that work. They run once for the whole sync,
+and not at all for a `--dry-run` or when there is nothing to sync.
 
 **Arguments:**
 - `changelist` (optional): Changelist number to sync up to, or `head` for the latest. Omit to sync to the
@@ -639,12 +650,25 @@ clone, so no `chmod` is needed.
 #### block-while-running (pre-sync)
 
 Aborts the sync while a named process is running, so a sync cannot swap out assets that a running editor still
-has loaded:
+has loaded. Link it into your workspace's `pre-sync` hook directory - on macOS and Linux:
 
 ```sh
 ln -s /path/to/git-p4son/examples/hooks/pre-sync/block-while-running.py .git-p4son/hooks/pre-sync/
 ```
 
+On Windows, from PowerShell. Note that `-Path` is the link to create and `-Target` the existing file, the
+reverse of the `ln -s` argument order, and that `-Target` should be absolute: a relative path is resolved
+against the current directory and quietly produces a broken link.
+
+```powershell
+New-Item -ItemType SymbolicLink `
+  -Path   "C:\p4\my-workspace\.git-p4son\hooks\pre-sync\block-while-running.py" `
+  -Target "C:\src\git-p4son\examples\hooks\pre-sync\block-while-running.py"
+```
+
+Creating a symlink on Windows needs either an elevated shell or Developer Mode enabled (Settings > System >
+For developers). Without one of those, copy the file instead and re-copy it whenever the clone updates.
+
 Which processes block a sync is read from your workspace's own `.git-p4son/config.toml`, so a symlinked hook
 stays per-project:
 

{git_p4son-0.3.2 → git_p4son-0.3.4}/README.md

@@ -208,6 +208,14 @@ be managed manually or via Perforce directly.
 After syncing, git-p4son prints a summary of how each writable file was handled, and instructs you to review and
 commit any files that need attention.
 
+**Workspaces with `allwrite`** - When your client spec has the `allwrite` option, every file is writable by design,
+so the read-only flag carries no information about local changes. git-p4son classifies files exactly as above (the
+verdict comes from git, not from the flag), but leaves the write bit alone on files it finds unchanged: with
+`noclobber` Perforce compares digests before refusing to overwrite a writable file, and unchanged files pass that
+check. Only files with local changes are made read-only for the duration of the sync, since those are the ones
+Perforce would otherwise refuse to overwrite. The same digest check applies to git-ignored files: unchanged ones sync
+normally, and after the sync git-p4son lists the ones Perforce skipped because they were modified locally.
+
 ## Usage
 
 git-p4son provides nine commands: `init`, `sync`, `sync-split`, `new`, `update`, `review`, `list-changes`,
@@ -312,7 +320,10 @@ own submits one at a time. Repeat `--user` to split out several people's changel
 It is equivalent to working out the numbers by hand and running
 `git p4son sync <before-theirs> <theirs> ... head`, and it delegates to `sync` once the sequence is
 resolved, so [pre-sync and post-sync hooks](#hooks), writable-file merging, and the clean-workspace checks
-all behave exactly as they do for `sync`.
+all behave exactly as they do for `sync`. The clean-workspace checks and the pre-sync hooks are the one
+thing that runs earlier: resolving the sequence costs several Perforce queries, so they go first, and a
+dirty workspace or a hook that aborts the sync says so before that work. They run once for the whole sync,
+and not at all for a `--dry-run` or when there is nothing to sync.
 
 **Arguments:**
 - `changelist` (optional): Changelist number to sync up to, or `head` for the latest. Omit to sync to the
@@ -616,12 +627,25 @@ clone, so no `chmod` is needed.
 #### block-while-running (pre-sync)
 
 Aborts the sync while a named process is running, so a sync cannot swap out assets that a running editor still
-has loaded:
+has loaded. Link it into your workspace's `pre-sync` hook directory - on macOS and Linux:
 
 ```sh
 ln -s /path/to/git-p4son/examples/hooks/pre-sync/block-while-running.py .git-p4son/hooks/pre-sync/
 ```
 
+On Windows, from PowerShell. Note that `-Path` is the link to create and `-Target` the existing file, the
+reverse of the `ln -s` argument order, and that `-Target` should be absolute: a relative path is resolved
+against the current directory and quietly produces a broken link.
+
+```powershell
+New-Item -ItemType SymbolicLink `
+  -Path   "C:\p4\my-workspace\.git-p4son\hooks\pre-sync\block-while-running.py" `
+  -Target "C:\src\git-p4son\examples\hooks\pre-sync\block-while-running.py"
+```
+
+Creating a symlink on Windows needs either an elevated shell or Developer Mode enabled (Settings > System >
+For developers). Without one of those, copy the file instead and re-copy it whenever the clone updates.
+
 Which processes block a sync is read from your workspace's own `.git-p4son/config.toml`, so a symlinked hook
 stays per-project:
 

{git_p4son-0.3.2 → git_p4son-0.3.4}/git_p4son/__init__.py

@@ -7,6 +7,6 @@ creating and updating changelists, and managing Swarm reviews.
 
 CONFIG_DIR = '.git-p4son'
 
-__version__ = "0.3.2"
+__version__ = "0.3.4"
 __author__ = "Andreas Andersson"
 __email__ = "andreas@neoboid.com"

{git_p4son-0.3.2 → git_p4son-0.3.4}/git_p4son/perforce.py

@@ -77,6 +77,10 @@ class P4ClientSpec:
     def clobber(self) -> bool:
         return 'clobber' in self.options
 
+    @property
+    def allwrite(self) -> bool:
+        return 'allwrite' in self.options
+
     @property
     def uses_crlf(self) -> bool:
         if self.line_end == 'win':
@@ -472,6 +476,12 @@ def is_binary_file_type(head_type: str) -> bool:
     return base_type in ('binary', 'ubinary')
 
 
+def is_always_writable_file_type(head_type: str) -> bool:
+    """Check if a Perforce headType carries the +w (always writable) modifier."""
+    _, _, modifiers = head_type.partition('+')
+    return 'w' in modifiers
+
+
 @dataclass
 class P4SyncPreviewFile:
     """A file a sync would affect, from p4 sync -n output.