Can you “ignore” a file in Perforce?
I sometimes use the feature ‘Reconcile Offline Work…’ found in Perforce’s P4V IDE to sync up any files that I have been working on while disconnected from the P4 depot. It launches another window that performs a ‘Folder Diff’.
I have files I never want to check in to source control (like ones found in bin folder such as DLLs, code generated output, etc.) Is there a way to filter those files/folders out from appearing as “new” that might be added. They tend to clutter up the list of files that I am actually interested in. Does P4 have the equivalent of Subversion’s ‘ignore file’ feature?
10 Solutions collect form web for “Can you “ignore” a file in Perforce?”
As of version 2012.1, Perforce supports the
P4IGNORE environment variable. I updated my answer to this question about ignoring directories with an explanation of how it works. Then I noticed this answer, which is now superfluous I guess.
Assuming you have a client named “CLIENT”, a directory named “foo” (located at your project root), and you wish to ignore all .dll files in that directory tree, you can add the following lines to your workspace view to accomplish this:
-//depot/foo/*.dll //CLIENT/foo/*.dll -//depot/foo/.../*.dll //CLIENT/foo/.../*.dll
The first line removes them from the directory “foo” and the second line removes them from all sub directories. Now, when you ‘Reconcile Offline Work…’, all the .dll files will be moved into “Excluded Files” folders at the bottom of the folder diff display. They will be out of your way, but can still view and manipulate them if you really need to.
You can also do it another way, which will reduce your “Excluded Files” folder to just one, but you won’t be able to manipulate any of the files it contains because the path will be corrupt (but if you just want them out of your way, it doesn’t matter).
Perforce version 2012.1 added a feature known as p4ignore, inspired by Git. However the Perforce developers made a change to the behaviour, without justification, that happens to make the feature a lot less useful.
Whilst Git takes rules from all
.gitignore files, Perforce doesn’t know where to look until you specify a filename in an environment variable
P4IGNORE. This freedom is a curse. You can’t hack on two repositories that use different names for their ignore files.
Also, Perforce’s ignore feature doesn’t work out the box. You can set it up easily enough for yourself, but others don’t benefit unless they explicitly opt-in. A contributor who hasn’t may accidentally commit unwelcome files (eg. a
bin folder created by a build script).
Git’s ignore feature is great because it works out the box. If the
.gitignore files are added to the repository (everyone does this), they’ll work out the box for everyone. No-one will accidentally publish their private key.
Amusingly, the Perforce docs shows ‘.p4ignore’ as an example ignore rule, which is backwards! If the rules are useful, they should be shared as part of the repository.
Perforce could still make good on the feature. Choose a convention for the file names, say
p4ignore.txt, so the feature works out the box. Drop the
P4IGNORE environment variable, it’s counterproductive. Edit the docs, to encourage developers to share useful rules. Let users write personal rules in a file in their home folder, as Git does.
If you know anyone at Perforce, please email them this post.
This works as of Perforce 2013.1, the new P4IGNORE mechanism was first added in release, 2012.1, described on the Perforce blog here:
As it’s currently described, you set an environment variable “P4IGNORE” to a filename which contains a list of the files to ignore.
So you can check it out to see how you like it.
If you want a solution that will apply to all work-spaces without needing to be copied around, you (or your sysadmin) can refuse submission of those file-types through using lines like the below in the p4 protect table:
write user * * -//.../*.suo write user * * -//.../*.obj write user * * -//.../*.ccscc
I remember doing this before, but I don’t have the necessary permissions to test this here. Check out Perforce’s Sysadmin guide and try it out
Perforce Streams makes ignoring files much easier, as of version 2011.1. According to the documentation, you can ignore certain extensions or certain paths in your directory.
p4 help stream
Ignored: Optional; a list of file or directory names to be ignored in client views. For example: /tmp # ignores files named 'tmp' /tmp/... # ignores dirs named 'tmp' .tmp # ignores file names ending in '.tmp' Lines in the Ignored field may appear in any order. Ignored names are inherited by child stream client views.
This essentially does what @raven’s answer specifies, but is done easier with streams, as it automatically propagates to every work-space using that stream. It also applies to any streams inheriting from the stream in which you specify the ignore types.
You can edit the stream via
p4 stream //stream_depot/stream_name or right-clicking the stream in p4v’s stream view.
And as @svec noted, the ability to specify ignore files per workspace is coming soon, and is in fact in P4 2012.1 beta.
Will’s suggestion of using
.p4ignore only seems to work with the WebSphere Studio (P4WSAD) plugin. I just tried it on my local windows box and any files and directories that I listed were not ignored.
Raven’s suggestion of modifying your client spec is the correct way under Perforce. Proper organization of your code/data/executables and generated output files will make the process of excluding files from being checked in much easier.
As a more draconian approach, you can always write a submit trigger which will reject submission of change-lists if they contain a certain file or files with a certain extension, etc.
HISTORICAL ANSWER – no longer correct. At the time this was written originally it was true;
You can not write and check in a file that the server will use to make ignore rules; general glob or regexp file pattern ignore in perforce.
Other answers have global server configurations that are global (and not per folder).
The other answers show things that might work for you, if you want one line in your view per folder times number of extensions you want to ignore in that single folder, or that provide this capability in WebSphere Studio plugins only, or provide capability for server administrators, but not available to users.
In short, I find Perforce really weak in this area. While I appreciate that those who use the Eclipse Plugin can use
.p4ignore, and I think that’s great, it leaves those of us that don’t, out in the dark.
UPDATE: See accepted answer for new P4IGNORE capability added mid-2012.
I have found it easiest to reconcile offline work using a BASH script like this one:
#!/bin/bash # reconcile P4 offline work, assuming P4CLIENT is set if [ -z "$P4CLIENT" ] ; then echo "P4CLIENT is not set"; exit 1; fi unset PWD # confuses P4 on Windows/CYGWIN # delete filew that are no longer present p4 diff -sd ... | p4 -x - delete # checkout files that have been changed. # I don't run this step. Instead I just checkout everything, # then revert unchanged files before committing. p4 diff -se ... | pr -x - edit # Add new files, ignoring subversion info, EMACS backups, log files # Filter output to see only added files and real errors find . -type f \ | grep -v -E '(\.svn)|(/build.*/)|(/\.settings)|~|#|(\.log)' \ | p4 -x - add \ | grep -v -E '(currently opened for add)|(existing file)|(already opened for edit)'
I adapted this from this Perforce Knowledge Base article.
I’m looking for a .p4ignore like solution as well (and not one tied to a particular IDE). Thus far, the closest thing I’ve found is p4delta. It sounds like it will do exactly what the original poster was asking, albeit through another layer of indirection.
Unfortunately, while this does seem to produce the proper list of files, I can’t get “p4delta –execute” to work (“Can’t modify a frozen string”) and the project has not been updated in year. Perhaps others will have better luck.
If you are using the Eclipse Perforce plugin, then the plugin documentation lists several ways to ignore files.