git-p4: asciidoc documentation and fixes
cover git-p4: asciidoc documentation and fixes
This series starts with a revamp of the documentation for git-p4, moving it into Documentation/ with the rest of the docs. Changes from v1 of this patch address:
- review comments by Frans Klaver <[email protected]>
- review comments by Luke Diamand <[email protected]>
- spellcheck
The other ten patches clarify the documentation, adding tests to verify the current behavior of various git-p4 options. Three of these also modify git-p4 itself.
Patch 6 adds code to catch two conflicting options.
Patch 10 fixes an obvious bug where both an option and a variable existed, but were honored inconsistently.
Patch 11 catches an invocation problem and exits early with an error message instead of waiting for an exception later.
Suggestions on how to rearrange these patches would be welcome. I think the series is otherwise ready for testing in next.
-- Pete
Pete Wyckoff (11):
git-p4: introduce asciidoc documentation
git-p4: test debug macro
git-p4: clone does not use --git-dir
git-p4: test cloning with two dirs, clarify doc
git-p4: document and test clone --branch
git-p4: honor --changesfile option and test
git-p4: document and test --import-local
git-p4: test --max-changes
git-p4: test --keep-path
git-p4: test and document --use-client-spec
git-p4: document and test submit options
Documentation/git-p4.txt | 480 ++++++++++++++++++++++++++++++++++++++++ contrib/fast-import/git-p4 | 32 +++- contrib/fast-import/git-p4.txt | 302 ------------------------- t/lib-git-p4.sh | 27 +++ t/t9800-git-p4.sh | 60 +++++ t/t9806-options.sh | 170 ++++++++++++++ t/t9807-submit.sh | 54 +++++ 7 files changed, 820 insertions(+), 305 deletions(-) create mode 100644 Documentation/git-p4.txt delete mode 100644 contrib/fast-import/git-p4.txt create mode 100755 t/t9806-options.sh
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 1/11 git-p4: introduce asciidoc documentation
Add proper documentation for git-p4. Delete the old .txt documentation from contrib/fast-import.
---
Changes from v1:
- review comments from Frans
- review comments from Luke
- spellcheck
Documentation/git-p4.txt | 456 ++++++++++++++++++++++++++++++++++++++++ contrib/fast-import/git-p4.txt | 302 -------------------------- 2 files changed, 456 insertions(+), 302 deletions(-) create mode 100644 Documentation/git-p4.txt delete mode 100644 contrib/fast-import/git-p4.txt
Documentation/git-p4.txt new file +456 -0
@@ -0,0 +1,456 @@ +git-p4(1) +========= + +NAME +---- +git-p4 - Import from and submit to Perforce repositories + + +SYNOPSIS +-------- +[verse] +'git p4 clone' [<sync options>] [<clone options>] <p4 depot path>... +'git p4 sync' [<sync options>] [<p4 depot path>...] +'git p4 rebase' +'git p4 submit' [<submit options>] [<master branch name>] + + +DESCRIPTION +----------- +This command provides a way to interact with p4 repositories +using git. + +Create a new git repository from an existing p4 repository using +'git p4 clone', giving it one or more p4 depot paths. Incorporate +new commits from p4 changes with 'git p4 sync'. The 'sync' command +is also used to include new branches from other p4 depot paths. +Submit git changes back to p4 using 'git p4 submit'. The command +'git p4 rebase' does a sync plus rebases the current branch onto +the updated p4 remote branch. + + +EXAMPLE +------- +* Create an alias for 'git p4', using the full path to the 'git-p4' + script if needed: ++ +------------ +$ git config --global alias.p4 '!git-p4' +------------ + +* Clone a repository: ++ +------------ +$ git p4 clone //depot/path/project +------------ + +* Do some work in the newly created git repository: ++ +------------ +$ cd project +$ vi foo.h +$ git commit -a -m "edited foo.h" +------------ + +* Update the git repository with recent changes from p4, rebasing your + work on top: ++ +------------ +$ git p4 rebase +------------ + +* Submit your commits back to p4: ++ +------------ +$ git p4 submit +------------ + + +COMMANDS +-------- + +Clone +~~~~~ +Generally, 'git p4 clone' is used to create a new git directory +from an existing p4 repository: +------------ +$ git p4 clone //depot/path/project +------------ +This: + +1. Creates an empty git repository in a subdirectory called 'project'. ++ +2. Imports the full contents of the head revision from the given p4 +depot path into a single commit in the git branch 'refs/remotes/p4/master'. ++ +3. Creates a local branch, 'master' from this remote and checks it out. + +To reproduce the entire p4 history in git, use the '@all' modifier on +the depot path: +------------ +$ git p4 clone //depot/path/project@all +------------ + + +Sync +~~~~ +As development continues in the p4 repository, those changes can +be included in the git repository using: +------------ +$ git p4 sync +------------ +This command finds new changes in p4 and imports them as git commits. + +P4 repositories can be added to an existing git repository using +'git p4 sync' too: +------------ +$ mkdir repo-git +$ cd repo-git +$ git init +$ git p4 sync //path/in/your/perforce/depot +------------ +This imports the specified depot into +'refs/remotes/p4/master' in an existing git repository. The +'--branch' option can be used to specify a different branch to +be used for the p4 content. + +If a git repository includes branches 'refs/remotes/origin/p4', these +will be fetched and consulted first during a 'git p4 sync'. Since +importing directly from p4 is considerably slower than pulling changes +from a git remote, this can be useful in a multi-developer environment. + + +Rebase +~~~~~~ +A common working pattern is to fetch the latest changes from the p4 depot +and merge them with local uncommitted changes. Often, the p4 repository +is the ultimate location for all code, thus a rebase workflow makes +sense. This command does 'git p4 sync' followed by 'git rebase' to move +local commits on top of updated p4 changes. +------------ +$ git p4 rebase +------------ + + +Submit +~~~~~~ +Submitting changes from a git repository back to the p4 repository +requires a separate p4 client workspace. This should be specified +using the 'P4CLIENT' environment variable or the git configuration +variable 'git-p4.client'. The p4 client must exist, but the client root +will be created and populated if it does not already exist. + +To submit all changes that are in the current git branch but not in +the 'p4/master' branch, use: +------------ +$ git p4 submit +------------ + +To specify a branch other than the current one, use: +------------ +$ git p4 submit topicbranch +------------ + +The upstream reference is generally 'refs/remotes/p4/master', but can +be overridden using the '--origin=' command-line option. + +The p4 changes will be created as the user invoking 'git p4 submit'. The +'--preserve-user' option will cause ownership to be modified +according to the author of the git commit. This option requires admin +privileges in p4, which can be granted using 'p4 protect'. + + +OPTIONS +------- + +General options +~~~~~~~~~~~~~~~ +All commands except clone accept this option. + +--git-dir <dir>:: + Set the 'GIT_DIR' environment variable. See linkgit:git[1]. + +Sync options +~~~~~~~~~~~~ +These options can be used in the initial 'clone' as well as in +subsequent 'sync' operations. + +--branch <branch>:: + Import changes into given branch. If the branch starts with + 'refs/', it will be used as is, otherwise the path 'refs/heads/' + will be prepended. The default branch is 'master'. + +--detect-branches:: + Use the branch detection algorithm to find new paths in p4. It is + documented below in "BRANCH DETECTION". + +--changesfile <file>:: + Import exactly the p4 change numbers listed in 'file', one per + line. Normally, 'git p4' inspects the current p4 repository + state and detects the changes it should import. + +--silent:: + Do not print any progress information. + +--verbose:: + Provide more progress information. + +--detect-labels:: + Query p4 for labels associated with the depot paths, and add + them as tags in git. + +--import-local:: + By default, p4 branches are stored in 'refs/remotes/p4/', + where they will be treated as remote-tracking branches by + linkgit:git-branch[1] and other commands. This option instead + puts p4 branches in 'refs/heads/p4/'. + +--max-changes <n>:: + Limit the number of imported changes to 'n'. Useful to + limit the amount of history when using the '@all' p4 revision + specifier. + +--keep-path:: + The mapping of file names from the p4 depot path to git, by + default, involves removing the entire depot path. With this + option, the full p4 depot path is retained in git. For example, + path '//depot/main/foo/bar.c', when imported from + '//depot/main/', becomes 'foo/bar.c'. With '--keep-path', the + git path is instead 'depot/main/foo/bar.c'. + +--use-client-spec:: + Use a client spec to find the list of interesting files in p4. + The client spec is discovered using 'p4 client -o' which checks + the 'P4CLIENT' environment variable and returns a mapping of + depot files to workspace files. + +Clone options +~~~~~~~~~~~~~ +These options can be used in an initial 'clone', along with the 'sync' +options described above. + +--destination <directory>:: + Where to create the git repository. If not provided, the last + component in the p4 depot path is used to create a new + directory. + +--bare:: + Perform a bare clone. See linkgit:git-clone[1]. + +-/ <path>:: + Exclude selected depot paths when cloning. + +Submit options +~~~~~~~~~~~~~~ +These options can be used to modify 'git p4 submit' behavior. + +--verbose:: + Provide more progress information. + +--origin <commit>:: + Upstream location from which commits are identified to submit to + p4. By default, this is the most recent p4 commit reachable + from 'HEAD'. + +-M[<n>]:: + Detect renames. See linkgit:git-diff[1]. Renames will be + represented in p4 using explicit 'move' operations. + +--preserve-user:: + Re-author p4 changes before submitting to p4. This option + requires p4 admin privileges. + + +DEPOT PATH SYNTAX +----------------- +The p4 depot path argument to 'git p4 sync' and 'git p4 clone' can +be one or more space-separated p4 depot paths, with an optional +p4 revision specifier on the end: + +"//depot/my/project":: + Import one commit with all files in the '#head' change under that tree. + +"//depot/my/project@all":: + Import one commit for each change in the history of that depot path. + +"//depot/my/project@1,6":: + Import only changes 1 through 6. + +"//depot/proj1 //depot/proj2@all":: + Import all changes from both named depot paths. + +See 'p4 help revisions' for the full syntax of p4 revision specifiers. + + +BRANCH DETECTION +---------------- +P4 does not have the same concept of a branch as git. Instead, +p4 organizes its content as a directory tree, where by convention +different logical branches are in different locations in the tree. +The 'p4 branch' command is used to maintain mappings between +different areas in the tree, and indicate related content. 'git p4' +can use these mappings to determine branch relationships. + +If you have a repository where all the branches of interest exist as +subdirectories of a single depot path, you can use '--detect-branches' +when cloning or syncing to have 'git p4' automatically find +subdirectories in p4, and to generate these as branches in git. + +For example, if the P4 repository structure is: +---- +//depot/main/... +//depot/branch1/... +---- + +And "p4 branch -o branch1" shows a View line that looks like: +---- +//depot/main/... //depot/branch1/... +---- + +Then this 'git p4 clone' command: +---- +git p4 clone --detect-branches //depot@all +---- +produces a separate branch in 'refs/remotes/p4/' for //depot/main, +called 'master', and one for //depot/branch1 called 'depot/branch1'. + +However, it is not necessary to create branches in p4 to be able to use +them like branches. Because it is difficult to infer branch +relationships automatically, a git configuration setting +'git-p4.branchList' can be used to explicitly identify branch +relationships. It is a list of "source:destination" pairs, like a +simple p4 branch specification, where the "source" and "destination" are +the path elements in the p4 repository. The example above relied on the +presence of the p4 branch. Without p4 branches, the same result will +occur with: +---- +git config git-p4.branchList main:branch1 +git p4 clone --detect-branches //depot@all +---- + + +PERFORMANCE +----------- +The fast-import mechanism used by 'git p4' creates one pack file for +each invocation of 'git p4 sync'. Normally, git garbage compression +(linkgit:git-gc[1]) automatically compresses these to fewer pack files, +but explicit invocation of 'git repack -adf' may improve performance. + + +CONFIGURATION VARIABLES +----------------------- +The following config settings can be used to modify 'git p4' behavior. +They all are in the 'git-p4' section. + +General variables +~~~~~~~~~~~~~~~~~ +git-p4.user:: + User specified as an option to all p4 commands, with '-u <user>'. + The environment variable 'P4USER' can be used instead. + +git-p4.password:: + Password specified as an option to all p4 commands, with + '-P <password>'. + The environment variable 'P4PASS' can be used instead. + +git-p4.port:: + Port specified as an option to all p4 commands, with + '-p <port>'. + The environment variable 'P4PORT' can be used instead. + +git-p4.host:: + Host specified as an option to all p4 commands, with + '-h <host>'. + The environment variable 'P4HOST' can be used instead. + +git-p4.client:: + Client specified as an option to all p4 commands, with + '-c <client>'. This can also be used as a way to find + the client spec for the 'useClientSpec' option. + The environment variable 'P4CLIENT' can be used instead. + +Clone and sync variables +~~~~~~~~~~~~~~~~~~~~~~~~ +git-p4.syncFromOrigin:: + Because importing commits from other git repositories is much faster + than importing them from p4, a mechanism exists to find p4 changes + first in git remotes. If branches exist under 'refs/remote/origin/p4', + those will be fetched and used when syncing from p4. This + variable can be set to 'false' to disable this behavior. + +git-p4.branchUser:: + One phase in branch detection involves looking at p4 branches + to find new ones to import. By default, all branches are + inspected. This option limits the search to just those owned + by the single user named in the variable. + +git-p4.branchList:: + List of branches to be imported when branch detection is + enabled. Each entry should be a pair of branch names separated + by a colon (:). This example declares that both branchA and + branchB were created from main: +------------- +git config git-p4.branchList main:branchA +git config --add git-p4.branchList main:branchB +------------- + +git-p4.useClientSpec:: + Specify that the p4 client spec to be used to identify p4 depot + paths of interest. This is equivalent to specifying the option + '--use-client-spec'. The variable 'git-p4.client' can be used + to specify the name of the client. + +Submit variables +~~~~~~~~~~~~~~~~ +git-p4.detectRenames:: + Detect renames. See linkgit:git-diff[1]. + +git-p4.detectCopies:: + Detect copies. See linkgit:git-diff[1]. + +git-p4.detectCopiesHarder:: + Detect copies harder. See linkgit:git-diff[1]. + +git-p4.preserveUser:: + On submit, re-author changes to reflect the git author, + regardless of who invokes 'git p4 submit'. + +git-p4.allowMissingP4Users:: + When 'preserveUser' is true, 'git p4' normally dies if it + cannot find an author in the p4 user map. This setting + submits the change regardless. + +git-p4.skipSubmitEdit:: + The submit process invokes the editor before each p4 change + is submitted. If this setting is true, though, the editing + step is skipped. + +git-p4.skipSubmitEditCheck:: + After editing the p4 change message, 'git p4' makes sure that + the description really was changed by looking at the file + modification time. This option disables that test. + +git-p4.allowSubmit:: + By default, any branch can be used as the source for a 'git p4 + submit' operation. This configuration variable, if set, permits only + the named branches to be used as submit sources. + +git-p4.skipUserNameCheck:: + If the user running 'git p4 submit' does not exist in the p4 + user map, 'git p4' exits. This option can be used to force + submission regardless. + + +IMPLEMENTATION DETAILS +---------------------- +* Changesets from p4 are imported using git fast-import. +* Cloning or syncing does not require a p4 client; file contents are + collected using 'p4 print'. +* Submitting requires a p4 client, which is not in the same location + as the git repository. Patches are applied, one at a time, to + this p4 client and submitted from there. +* Each commit imported by 'git p4' has a line at the end of the log + message indicating the p4 depot location and change number. This + line is used by later 'git p4 sync' operations to know which p4 + changes are new. +
contrib/fast-import/git-p4.txt deleted +0 -302
302 lines not on this page · raw message
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 2/11 git-p4: test debug macro
In reply to Pete WyckoffCall this from a test to have it pause and wait for you to investigate. It prints out its current directory and the P4 environment variables. It waits for ctrl-c before continuing the test.
--- t/lib-git-p4.sh | 27 +++++++++++++++++++++++++++ 1 files changed, 27 insertions(+), 0 deletions(-)
t/lib-git-p4.sh +27 -0
@@ -72,3 +72,30 @@ kill_p4d() { cleanup_git() { rm -rf "$git" } + +# +# This is a handy tool when developing or debugging tests. Use +# it inline to pause the script, perhaps like this: +# +# "$GITP4" clone ... && +# ( +# cd "$git" && +# debug && +# git log --oneline >lines && +# ... +# +# Go investigate when it pauses, then hit ctrl-c to continue the +# test. The other tests will run, and p4d will be cleaned up nicely. +# +# Note that the directory is deleted and created for every test run, +# so you have to do the "cd" again. +# +debug() { + echo "*** Debug me, hit ctrl-c when done. Useful shell commands:" + echo cd \"$(pwd)\" + echo export P4PORT=$P4PORT P4CLIENT=$P4CLIENT + trap echo SIGINT + sleep $((3600 * 24 * 30)) + trap - SIGINT +} +
Signature · 1 line
1.7.8.258.g45cc3c
Re: [PATCH 02/11] git-p4: test debug macro
Quoted 5 lines · Pete Wyckoff
Call this from a test to have it pause and wait for you to investigate. It prints out its current directory and the P4 environment variables. It waits for ctrl-c before continuing the test.
Very useful, thanks!
t/lib-git-p4.sh kill_p4d() { · line 97
Quoted 11 lines
t/lib-git-p4.sh +11
-0+# Go investigate when it pauses, then hit ctrl-c to continue the +# test. The other tests will run, and p4d will be cleaned up nicely. +# +# Note that the directory is deleted and created for every test run, +# so you have to do the "cd" again. +# +debug() { + echo "*** Debug me, hit ctrl-c when done. Useful shell commands:" + echo cd \"$(pwd)\" + echo export P4PORT=$P4PORT P4CLIENT=$P4CLIENT + trap echo SIGINT
Does that work with non-bash shells like ash? It didn't for me.
Quoted 4 lines
t/lib-git-p4.sh +4
-0+ sleep $((3600 * 24 * 30)) + trap - SIGINT +} +
PATCH v2 2/11 git-p4: test debug macro
Call this from a test to have it pause and wait for you to investigate. It prints out its current directory and the P4 environment variables. It waits for ctrl-c before continuing the test.
---
[email protected] wrote on Sat, 17 Dec 2011 22:43 +0000:
Quoted 14 lines
Review
Quoted 11 lines
(quoted diff) +11
-0+# Go investigate when it pauses, then hit ctrl-c to continue the +# test. The other tests will run, and p4d will be cleaned up nicely. +# +# Note that the directory is deleted and created for every test run, +# so you have to do the "cd" again. +# +debug() { + echo "*** Debug me, hit ctrl-c when done. Useful shell commands:" + echo cd \"$(pwd)\" + echo export P4PORT=$P4PORT P4CLIENT=$P4CLIENT + trap echo SIGINTDoes that work with non-bash shells like ash? It didn't for me.
Quoted 4 lines
Review
Quoted 4 lines
(quoted diff) +4
-0+ sleep $((3600 * 24 * 30)) + trap - SIGINT +} +
Indeed. At least debian's ash is just dash, and version 0.5.7-2 doesn't know the symbolic signal names.
Thanks for noticing.
t/lib-git-p4.sh | 28 ++++++++++++++++++++++++++++ 1 files changed, 28 insertions(+), 0 deletions(-)
t/lib-git-p4.sh +28 -0
@@ -72,3 +72,31 @@ kill_p4d() { cleanup_git() { rm -rf "$git" } + +# +# This is a handy tool when developing or debugging tests. Use +# it inline to pause the script, perhaps like this: +# +# "$GITP4" clone ... && +# ( +# cd "$git" && +# debug && +# git log --oneline >lines && +# ... +# +# Go investigate when it pauses, then hit ctrl-c to continue the +# test. The other tests will run, and p4d will be cleaned up nicely. +# +# Note that the directory is deleted and created for every test run, +# so you have to do the "cd" again. +# +debug() { + echo "*** Debug me, hit ctrl-c when done. Useful shell commands:" + echo cd \"$(pwd)\" + echo export P4PORT=$P4PORT P4CLIENT=$P4CLIENT + # 2 is SIGINT, ash/dash does not know symbolic names + trap echo 2 + sleep $((3600 * 24 * 30)) + trap - 2 +} +
Signature · 1 line
1.7.8.285.gb668d
Re: [PATCHv2 02/11] git-p4: test debug macro
t/lib-git-p4.sh kill_p4d() { · line 98
Quoted 2 lines · Pete Wyckoff
t/lib-git-p4.sh +2
-0+ # 2 is SIGINT, ash/dash does not know symbolic names + trap echo 2
'trap "$cmd" INT' works, and it's even in POSIX. ;)
http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
Re: [PATCHv2 02/11] git-p4: test debug macro
[email protected] wrote on Sat, 17 Dec 2011 21:26 -0600:
Quoted 7 lines
t/lib-git-p4.sh kill_p4d() { · line 98
Quoted 2 lines · Pete Wyckoff
t/lib-git-p4.sh +2
-0+ # 2 is SIGINT, ash/dash does not know symbolic names + trap echo 2'trap "$cmd" INT' works, and it's even in POSIX. ;)
http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
Nice! But ash/dash handle subshell INT differently. With ash, the entire test exits after the ctrl-C, even if caught by a trap in a subshell. Not so nice. Here's a demonstration.
-----------8<-------------
# shell top.sh echo top.sh $SHELL trap.sh echo top.sh: exit status from trap.sh: $? echo top.sh: exiting exit 0 -----------8<-------------
-----------8<-------------
# shell trap.sh echo trap.sh trap "echo trap.sh caught INT" INT sleep 3600 trap - INT echo trap.sh: exiting exit 0 -----------8<-------------
Run "bash top.sh". Hit ctrl-c, you'll see:
$ bash top.sh
top.sh
trap.sh
^Ctrap.sh caught INT
trap.sh: exiting
top.sh: exit status from trap.sh: 0
top.sh: exitingSimilarly with "ash top.sh":
$ ash top.sh
top.sh
trap.sh
^Ctrap.sh caught INT
trap.sh: exitingThe top-level script also gets the ctrl-c, but exits on the INT anyway, after reaping its child. I can't find where POSIX says if this is correct or not. It isn't how I want it to work here.
I'll add a comment above debug() to explain that it works in bash but not ash. At least it prints out the P4 environment information needed to debug.
-- Pete
PATCH v3 2/11 git-p4: test debug macro
In reply to Jonathan NiederCall this from a test to have it pause and wait for you to investigate. It prints out its current directory and the P4 environment variables. It waits for ctrl-c before continuing the test.
---
[email protected] wrote on Sat, 17 Dec 2011 21:26 -0600:
Quoted 7 lines
Review
Quoted 2 lines · Pete Wyckoff
(quoted diff) +2
-0+ # 2 is SIGINT, ash/dash does not know symbolic names + trap echo 2'trap "$cmd" INT' works, and it's even in POSIX. ;)
http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
Nicer to use the constant. It works on both. Unfortunately ash has other issues regarding handling ctrl-c from subprocesses. Point this out in the comments.
t/lib-git-p4.sh | 31 +++++++++++++++++++++++++++++++ 1 files changed, 31 insertions(+), 0 deletions(-)
t/lib-git-p4.sh +31 -0
@@ -72,3 +72,34 @@ kill_p4d() { cleanup_git() { rm -rf "$git" } + +# +# This is a handy tool when developing or debugging tests. Use +# it inline to pause the script, perhaps like this: +# +# "$GITP4" clone ... && +# ( +# cd "$git" && +# debug && +# git log --oneline >lines && +# ... +# +# Go investigate when it pauses, then hit ctrl-c to continue the +# test. The other tests will run, and p4d will be cleaned up nicely. +# +# Note that the directory is deleted and created for every test run, +# so you have to do the "cd" again. +# +# The continuation feature only works in shells that do not propagate +# a child-caught ctrl-c, namely bash. With ash, the entire test run +# will exit on the ctrl-c. +# +debug() { + echo "*** Debug me, hit ctrl-c when done. Useful shell commands:" + echo cd \"$(pwd)\" + echo export P4PORT=$P4PORT P4CLIENT=$P4CLIENT + trap "echo" INT + sleep $((3600 * 24 * 30)) + trap - INT +} +
Signature · 1 line
1.7.8.285.gb668d
Re: [PATCHv3 02/11] git-p4: test debug macro
Quoted 4 lines · Pete Wyckoff
Call this from a test to have it pause and wait for you to investigate. It prints out its current directory and the P4 environment variables. It waits for ctrl-c before continuing the test.
Looks good, ack.
Quoted 58 lines
Signed-off-by Pete Wyckoff<[email protected]>---
[email protected] wrote on Sat, 17 Dec 2011 21:26 -0600:Quoted 7 lines
Review
Quoted 2 lines · Pete Wyckoff
(quoted diff) +2
-0+ # 2 is SIGINT, ash/dash does not know symbolic names + trap echo 2'trap "$cmd" INT' works, and it's even in POSIX. ;)
http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trapNicer to use the constant. It works on both. Unfortunately ash has other issues regarding handling ctrl-c from subprocesses. Point this out in the comments.
t/lib-git-p4.sh | 31 +++++++++++++++++++++++++++++++ 1 files changed, 31 insertions(+), 0 deletions(-)t/lib-git-p4.sh +31
-0@@ -72,3 +72,34 @@ kill_p4d() { cleanup_git() { rm -rf "$git" } + +# +# This is a handy tool when developing or debugging tests. Use +# it inline to pause the script, perhaps like this: +# +# "$GITP4" clone ...&& +# ( +# cd "$git"&& +# debug&& +# git log --oneline>lines&& +# ... +# +# Go investigate when it pauses, then hit ctrl-c to continue the +# test. The other tests will run, and p4d will be cleaned up nicely. +# +# Note that the directory is deleted and created for every test run, +# so you have to do the "cd" again. +# +# The continuation feature only works in shells that do not propagate +# a child-caught ctrl-c, namely bash. With ash, the entire test run +# will exit on the ctrl-c. +# +debug() { + echo "*** Debug me, hit ctrl-c when done. Useful shell commands:" + echo cd \"$(pwd)\" + echo export P4PORT=$P4PORT P4CLIENT=$P4CLIENT + trap "echo" INT + sleep $((3600 * 24 * 30)) + trap - INT +} +
Re: [PATCHv3 02/11] git-p4: test debug macro
In reply to Pete WyckoffQuoted 7 lines · Pete Wyckoff
Call this from a test to have it pause and wait for you to investigate. It prints out its current directory and the P4 environment variables. It waits for ctrl-c before continuing the test.
Signed-off-by Pete Wyckoff <[email protected]>---
...
Quoted 11 lines
t/lib-git-p4.sh +3
-0@@ -72,3 +72,34 @@ kill_p4d() { cleanup_git() { rm -rf "$git" } + +# +# This is a handy tool when developing or debugging tests. Use
t/lib-git-p4.sh kill_p4d() { · line 87
Quoted 10 lines
t/lib-git-p4.sh +10
-0+... +debug() { + echo "*** Debug me, hit ctrl-c when done. Useful shell commands:" + echo cd \"$(pwd)\" + echo export P4PORT=$P4PORT P4CLIENT=$P4CLIENT + trap "echo" INT + sleep $((3600 * 24 * 30)) + trap - INT +} +
You may have found this handy yourself, but I would rather not to see it here in the current form for multiple reasons.
- Why "ctrl-c"? You are not even spawning shell from here but are having the user interact with this state in the middle of a test from another shell, no?
Why not "When done, type <RET>" and have a "read junk" or something instead? That would be a lot simpler and you do not have to worry about portability with many lines of comments.
An alternative is to spawn an interactive shell here, and change the "Debug me" comment to say "ctrl-d when done".
- This is not linked to the generic "debug" option "txxxx-name.sh -d". Shouldn't you be extending test_debug so that it can go interactive, give customized comments&insns (i.e. "cd $here" may be useful for test scripts outside testing p4, but "P4PORT=..." would not be, so the user of test_debug in t9800-git-p4.* needs customizability of the message).
Also could we please rename p4 related tests in t/t98* series so that it is clear that they are about git-p4 from "ls t/" output (i.e. have them all have "git-p4" in their names)?
Re: [PATCHv3 02/11] git-p4: test debug macro
[email protected] wrote on Sun, 18 Dec 2011 13:48 -0800:
Quoted 7 lines
You may have found this handy yourself, but I would rather not to see it here in the current form for multiple reasons.
- Why "ctrl-c"? You are not even spawning shell from here but are having the user interact with this state in the middle of a test from another shell, no?
Quoted 6 lines
Why not "When done, type <RET>" and have a "read junk" or something instead? That would be a lot simpler and you do not have to worry about portability with many lines of comments.
An alternative is to spawn an interactive shell here, and change the "Debug me" comment to say "ctrl-d when done".
Good point. I'll get rid of all that trap business.
Quoted 5 lines
- This is not linked to the generic "debug" option "
txxxx-name.sh-d". Shouldn't you be extendingtest_debugso that it can go interactive, give customized comments&insns (i.e. "cd $here" may be useful for test scripts outside testing p4, but "P4PORT=..." would not be, so the user oftest_debugin t9800-git-p4.* needs customizability of the message).
That's good advice; each (set of) script(s) could customize as needed.
The pain of having to track down the P4PORT, which varies with each test script, was my main motivation for trying to automate this.
I'll not resubmit this one until coming up with something prettier.
Quoted 3 lines
Also could we please rename p4 related tests in t/t98* series so that it is clear that they are about git-p4 from "ls t/" output (i.e. have them all have "git-p4" in their names)?
Sure. That was a mistake. We'll fix it up.
-- Pete
PATCH 3/11 git-p4: clone does not use --git-dir
In reply to Pete WyckoffComplain if --git-dir is given during a clone. It has no effect. Only --destination and --bare can change where the newly cloned git dir will be.
--- contrib/fast-import/git-p4 | 3 ++- t/t9806-options.sh | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletions(-) create mode 100755 t/t9806-options.sh
contrib/fast-import/git-p4 +2 -1
@@ -2331,7 +2331,8 @@ def main(): args = sys.argv[2:] if len(options) > 0: - options.append(optparse.make_option("--git-dir", dest="gitdir")) + if cmd.needsGit: + options.append(optparse.make_option("--git-dir", dest="gitdir")) parser = optparse.OptionParser(cmd.usage.replace("%prog", "%prog " + cmdName), options,
t/t9806-options.sh new file +34 -0
@@ -0,0 +1,34 @@ +#!/bin/sh + +test_description='git-p4 options' + +. ./lib-git-p4.sh + +test_expect_success 'start p4d' ' + start_p4d +' + +test_expect_success 'init depot' ' + ( + cd "$cli" && + echo file1 >file1 && + p4 add file1 && + p4 submit -d "change 1" && + echo file2 >file2 && + p4 add file2 && + p4 submit -d "change 2" && + echo file3 >file3 && + p4 add file3 && + p4 submit -d "change 3" + ) +' + +test_expect_success 'clone no --git-dir' ' + test_must_fail "$GITP4" clone --git-dir=xx //depot +' + +test_expect_success 'kill p4d' ' + kill_p4d +' + +test_done
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 4/11 git-p4: test cloning with two dirs, clarify doc
In reply to Pete WyckoffDocument how git-p4 currently works when specifying multiple depot paths:
1. No branches or directories are named.
2. Conflicting files are silently ignored---the last change wins.
2. Option --destination is required, else the last path is construed to be a directory.
3. Revision specifiers must be the same on all paths for them to take effect.
Test this behavior.
--- Documentation/git-p4.txt | 11 +++++++- t/t9800-git-p4.sh | 60 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 2 deletions(-)
Documentation/git-p4.txt +9 -2
@@ -276,8 +276,15 @@ p4 revision specifier on the end: "//depot/my/project@1,6":: Import only changes 1 through 6. -"//depot/proj1 //depot/proj2@all":: - Import all changes from both named depot paths. +"//depot/proj1@all //depot/proj2@all":: + Import all changes from both named depot paths into a single + repository. Only files below these directories are included. + There is not a subdirectory in git for each "proj1" and "proj2". + You must use the '--destination' option when specifying more + than one depot path. The revision specifier must be specified + identically on each depot path. If there are files in the + depot paths with the same name, the path with the most recently + updated version of the file is the one that appears in git. See 'p4 help revisions' for the full syntax of p4 revision specifiers.
t/t9800-git-p4.sh +60 -0
66 lines not on this page · raw message
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 5/11 git-p4: document and test clone --branch
In reply to Pete WyckoffClone with --branch will not checkout HEAD, unless the branch happens to be called the default refs/remotes/p4/master. The --branch option is most useful with sync; give an example of that.
--- Documentation/git-p4.txt | 10 +++++++++- t/t9806-options.sh | 11 +++++++++++ 2 files changed, 20 insertions(+), 1 deletions(-)
Documentation/git-p4.txt +9 -1
@@ -178,7 +178,15 @@ subsequent 'sync' operations. --branch <branch>:: Import changes into given branch. If the branch starts with 'refs/', it will be used as is, otherwise the path 'refs/heads/' - will be prepended. The default branch is 'master'. + will be prepended. The default branch is 'master'. If used + with an initial clone, no HEAD will be checked out. ++ +This example imports a new remote "p4/proj2" into an existing +git repository: +---- + $ git init + $ git p4 sync --branch=refs/remotes/p4/proj2 //depot/proj2 +---- --detect-branches:: Use the branch detection algorithm to find new paths in p4. It is
t/t9806-options.sh +11 -0
@@ -27,6 +27,17 @@ test_expect_success 'clone no --git-dir' ' test_must_fail "$GITP4" clone --git-dir=xx //depot ' +test_expect_success 'clone --branch' ' + "$GITP4" clone --branch=refs/remotes/p4/sb --dest="$git" //depot && + test_when_finished cleanup_git && + ( + cd "$git" && + git ls-files >files && + test_line_count = 0 files && + test_path_is_file .git/refs/remotes/p4/sb + ) +' + test_expect_success 'kill p4d' ' kill_p4d '
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 6/11 git-p4: honor --changesfile option and test
In reply to Pete WyckoffWhen an explicit list of changes is given, it makes no sense to use @all or @3,5 or any of the other p4 revision specifiers. Make the code notice when this happens, instead of just ignoring --changesfile. Test it.
--- contrib/fast-import/git-p4 | 16 +++++++++++++++- t/t9806-options.sh | 23 +++++++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletions(-)
contrib/fast-import/git-p4 +15 -1
@@ -2020,6 +2020,17 @@ class P4Sync(Command, P4UserMap): revision = "" self.users = {} + # Make sure no revision specifiers are used when --changesfile + # is specified. + bad_changesfile = False + if len(self.changesFile) > 0: + for p in self.depotPaths: + if p.find("@") >= 0 or p.find("#") >= 0: + bad_changesfile = True + break + if bad_changesfile: + die("Option --changesfile is incompatible with revision specifiers") + newPaths = [] for p in self.depotPaths: if p.find("@") != -1:
@@ -2036,7 +2047,10 @@ class P4Sync(Command, P4UserMap): revision = p[hashIdx:] p = p[:hashIdx] elif self.previousDepotPaths == []: - revision = "#head" + # pay attention to changesfile, if given, else import + # the entire p4 tree at the head revision + if len(self.changesFile) == 0: + revision = "#head" p = re.sub ("\.\.\.$", "", p) if not p.endswith("/"):
t/t9806-options.sh +23 -0
@@ -38,6 +38,29 @@ test_expect_success 'clone --branch' ' ) ' +test_expect_success 'clone --changesfile' ' + cf="$TRASH_DIRECTORY/cf" && + test_when_finished "rm \"$cf\"" && + printf "1\n3\n" >"$cf" && + "$GITP4" clone --changesfile="$cf" --dest="$git" //depot && + test_when_finished cleanup_git && + ( + cd "$git" && + git log --oneline p4/master >lines && + test_line_count = 2 lines + test_path_is_file file1 && + test_path_is_missing file2 && + test_path_is_file file3 + ) +' + +test_expect_success 'clone --changesfile, @all' ' + cf="$TRASH_DIRECTORY/cf" && + test_when_finished "rm \"$cf\"" && + printf "1\n3\n" >"$cf" && + test_must_fail "$GITP4" clone --changesfile="$cf" --dest="$git" //depot@all +' + test_expect_success 'kill p4d' ' kill_p4d '
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 7/11 git-p4: document and test --import-local
In reply to Pete WyckoffExplain that it is needed on future syncs to find p4 branches in refs/heads. Test this behavior.
--- Documentation/git-p4.txt | 4 +++- t/t9806-options.sh | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletions(-)
Documentation/git-p4.txt +3 -1
@@ -211,7 +211,9 @@ git repository: By default, p4 branches are stored in 'refs/remotes/p4/', where they will be treated as remote-tracking branches by linkgit:git-branch[1] and other commands. This option instead - puts p4 branches in 'refs/heads/p4/'. + puts p4 branches in 'refs/heads/p4/'. Note that future + sync operations must specify '--import-local' as well so that + they can find the p4 branches in refs/heads. --max-changes <n>:: Limit the number of imported changes to 'n'. Useful to
t/t9806-options.sh +22 -0
@@ -61,6 +61,28 @@ test_expect_success 'clone --changesfile, @all' ' test_must_fail "$GITP4" clone --changesfile="$cf" --dest="$git" //depot@all ' +# imports both master and p4/master in refs/heads +# requires --import-local on sync to find p4 refs/heads +# does not update master on sync, just p4/master +test_expect_success 'clone/sync --import-local' ' + "$GITP4" clone --import-local --dest="$git" //depot@1,2 && + test_when_finished cleanup_git && + ( + cd "$git" && + git log --oneline refs/heads/master >lines && + test_line_count = 2 lines && + git log --oneline refs/heads/p4/master >lines && + test_line_count = 2 lines && + test_must_fail "$GITP4" sync && + + "$GITP4" sync --import-local && + git log --oneline refs/heads/master >lines && + test_line_count = 2 lines && + git log --oneline refs/heads/p4/master >lines && + test_line_count = 3 lines + ) +' + test_expect_success 'kill p4d' ' kill_p4d '
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 8/11 git-p4: test --max-changes
In reply to Pete Wyckoff--- t/t9806-options.sh | 10 ++++++++++ 1 files changed, 10 insertions(+), 0 deletions(-)
t/t9806-options.sh +10 -0
@@ -83,6 +83,16 @@ test_expect_success 'clone/sync --import-local' ' ) ' +test_expect_success 'clone --max-changes' ' + "$GITP4" clone --dest="$git" --max-changes 2 //depot@all && + test_when_finished cleanup_git && + ( + cd "$git" && + git log --oneline refs/heads/master >lines && + test_line_count = 2 lines + ) +' + test_expect_success 'kill p4d' ' kill_p4d '
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 9/11 git-p4: test --keep-path
In reply to Pete WyckoffMake sure it leaves the path, below //depot, in git.
--- t/t9806-options.sh | 24 ++++++++++++++++++++++++ 1 files changed, 24 insertions(+), 0 deletions(-)
t/t9806-options.sh +24 -0
@@ -93,6 +93,30 @@ test_expect_success 'clone --max-changes' ' ) ' +test_expect_success 'clone --keep-path' ' + ( + cd "$cli" && + mkdir -p sub/dir && + echo f4 >sub/dir/f4 && + p4 add sub/dir/f4 && + p4 submit -d "change 4" + ) && + "$GITP4" clone --dest="$git" --keep-path //depot/sub/dir@all && + test_when_finished cleanup_git && + ( + cd "$git" && + test_path_is_missing f4 && + test_path_is_file sub/dir/f4 + ) && + cleanup_git && + "$GITP4" clone --dest="$git" //depot/sub/dir@all && + ( + cd "$git" && + test_path_is_file f4 && + test_path_is_missing sub/dir/f4 + ) +' + test_expect_success 'kill p4d' ' kill_p4d '
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 10/11 git-p4: test and document --use-client-spec
In reply to Pete WyckoffThe depot path is required, even with this option. Make sure git-p4 fails and exits with non-zero.
Contents in the specified depot path will be rearranged according to the client spec. Test this and add a note in the docs.
Leave an XXX suggesting that this is somewhat confusing behavior that might be good to fix later.
Function stripRepoPath() looks at self.useClientSpec. Make sure this is set both for command-line option --use-client-spec and for configuration variable git-p4.useClientSpec. Test this.
--- Documentation/git-p4.txt | 5 +++- contrib/fast-import/git-p4 | 6 ++++- t/t9806-options.sh | 46 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+), 2 deletions(-)
Documentation/git-p4.txt +4 -1
@@ -232,7 +232,10 @@ git repository: Use a client spec to find the list of interesting files in p4. The client spec is discovered using 'p4 client -o' which checks the 'P4CLIENT' environment variable and returns a mapping of - depot files to workspace files. + depot files to workspace files. Note that a depot path is + still required, but files found in the path that match in + the client spec view will be laid out according to the client + spec. Clone options ~~~~~~~~~~~~~
contrib/fast-import/git-p4 +5 -1
@@ -1947,7 +1947,10 @@ class P4Sync(Command, P4UserMap): if not gitBranchExists(self.refPrefix + "HEAD") and self.importIntoRemotes and gitBranchExists(self.branch): system("git symbolic-ref %sHEAD %s" % (self.refPrefix, self.branch)) - if self.useClientSpec or gitConfig("git-p4.useclientspec") == "true": + if not self.useClientSpec: + if gitConfig("git-p4.useclientspec", "--bool") == "true": + self.useClientSpec = True + if self.useClientSpec: self.getClientSpec() # TODO: should always look at previous commits,
@@ -2376,6 +2379,7 @@ def main(): if not cmd.run(args): parser.print_help() + sys.exit(2) if __name__ == '__main__':
t/t9806-options.sh +46 -0
52 lines not on this page · raw message
Signature · 1 line
1.7.8.258.g45cc3c
PATCH 11/11 git-p4: document and test submit options
In reply to Pete WyckoffClarify there is a -M option, but no -C. These are both configurable through variables.
Explain that the allowSubmit variable takes a comma-separated list of branch names.
Catch earlier an invalid branch name given as an argument to "git p4 clone".
Test option --origin, variable allowSubmit, and explicit master branch name.
--- Documentation/git-p4.txt | 8 +++++- contrib/fast-import/git-p4 | 7 +++++ t/t9807-submit.sh | 54 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 67 insertions(+), 2 deletions(-)
Documentation/git-p4.txt +6 -2
@@ -267,7 +267,9 @@ These options can be used to modify 'git p4 submit' behavior. -M[<n>]:: Detect renames. See linkgit:git-diff[1]. Renames will be - represented in p4 using explicit 'move' operations. + represented in p4 using explicit 'move' operations. There + is no corresponding option to detect copies, but there are + variables for both moves and copies. --preserve-user:: Re-author p4 changes before submitting to p4. This option
@@ -453,7 +455,9 @@ git-p4.skipSubmitEditCheck:: git-p4.allowSubmit:: By default, any branch can be used as the source for a 'git p4 submit' operation. This configuration variable, if set, permits only - the named branches to be used as submit sources. + the named branches to be used as submit sources. Branch names + must be the short names (no "refs/heads/"), and should be + separated by commas (","), with no spaces. git-p4.skipUserNameCheck:: If the user running 'git p4 submit' does not exist in the p4
contrib/fast-import/git-p4 +7 -0
@@ -362,6 +362,11 @@ def isValidGitDir(path): def parseRevision(ref): return read_pipe("git rev-parse %s" % ref).strip() +def branchExists(ref): + rev = read_pipe(["git", "rev-parse", "-q", "--verify", ref], + ignore_error=True) + return len(rev) > 0 + def extractLogMessageFromGitCommit(commit): logMessage = ""
@@ -1085,6 +1090,8 @@ class P4Submit(Command, P4UserMap): die("Detecting current git branch failed!") elif len(args) == 1: self.master = args[0] + if not branchExists(self.master): + die("Branch %s does not exist" % self.master) else: return False
t/t9807-submit.sh +54 -0
60 lines not on this page · raw message
Signature · 1 line
1.7.8.258.g45cc3c