How can i use ignore-me?

Created by Sascha Manns on on 2017-10-05
Keywords:
usage
Last updated by:
Sascha Manns on on 2017-10-05

TL:DR
====
Currently the following VCS are supported: GIT, BZR, HG, CVS, SVN.

The following workarounds are given:

BZR
1.) Go to your projects directory
2.) Run `copy-bzrmk`
3.) Run `make -f bzr.mk`
4.) Define a "BZRIGNOREFILES" into your Makefile.am, and add the file who should be
ignored.
5.) You can use in MAINTAINERCLEANFILES:
     * $(BZRIGNORE_MAINTAINERCLEANFILES_TOPLEVEL)
     * $(BZRIGNORE_MAINTAINERCLEANFILES_MAKEFILE_IN)
     * $(BZRIGNORE_MAINTAINERCLEANFILES_M4_LIBTOOL)

GIT
1.) Go to your projects directory
2.) Run `copy-gitmk`
3.) Run `make -f git.mk`
4.) Define a "GITIGNOREFILES" into your Makefile.am, and add the file who should be
ignored.
5.) You can use in MAINTAINERCLEANFILES:
     * $(GITIGNORE_MAINTAINERCLEANFILES_TOPLEVEL)
     * $(GITIGNORE_MAINTAINERCLEANFILES_MAKEFILE_IN)
     * $(GITIGNORE_MAINTAINERCLEANFILES_M4_LIBTOOL)

HG
1.) Go to your projects directory
2.) Run `copy-hgmk`
3.) Run `make -f hg.mk`
4.) Define a "HGIGNOREFILES" into your Makefile.am, and add the file who should be
ignored.
5.) You can use in MAINTAINERCLEANFILES:
     * $(HGIGNORE_MAINTAINERCLEANFILES_TOPLEVEL)
     * $(HGIGNORE_MAINTAINERCLEANFILES_MAKEFILE_IN)
     * $(HGIGNORE_MAINTAINERCLEANFILES_M4_LIBTOOL)

SVN
1.) Go to your projects directory
2.) Run `copy-svnmk`
3.) Run `make -f svn.mk`
4.) Define a "SVNIGNOREFILES" into your Makefile.am, and add the file who should be
ignored.
5.) You can use in MAINTAINERCLEANFILES:
     * $(SVNIGNORE_MAINTAINERCLEANFILES_TOPLEVEL)
     * $(SVNIGNORE_MAINTAINERCLEANFILES_MAKEFILE_IN)
     * $(SVNIGNORE_MAINTAINERCLEANFILES_M4_LIBTOOL)

CVS
1.) Go to your projects directory
2.) Run `copy-cvsmk`
3.) Run `make -f cvs.mk`
4.) Define a "CVSIGNOREFILES" into your Makefile.am, and add the file who should be
ignored.
5.) You can use in MAINTAINERCLEANFILES:
     * $(CVSIGNORE_MAINTAINERCLEANFILES_TOPLEVEL)
     * $(CVSIGNORE_MAINTAINERCLEANFILES_MAKEFILE_IN)
     * $(CVSIGNORE_MAINTAINERCLEANFILES_M4_LIBTOOL)

In case you are using another supported VCS, just replace all existing Bzr
occurences in this

More
===
The copy command modifies all Makefile.am files and includes itself there.

This enables automatic .bzrignore generation. If you need to ignore more files, add
them to the BZRIGNOREFILES variable in your Makefile.am.
But think twice before doing that. If a file has to be in a .xxxignore, chances are very
high that it's a generated file and should be in one of MOSTLYCLEANFILES, CLEANFILES,
DISTCLEANFILES, or MAINTAINERCLEANFILES.

The only case that you need to manually add a file to XXXIGNOREFILES is when remove
files in one of mostlyclean-local, clean-local, distclean-local, or
maintainer-clean-local make targets.

If "make maintainer-clean" removes the files but they are not recognized by this script
(that is, if eg. "bzr status" shows untracked files still), send me the output of
eg. "bzr status" as well as your Makefile.am and Makefile for the directories involved
and I'll diagnose.

For a list of toplevel files that should be in MAINTAINERCLEANFILES, see
Makefile.am.sample in the bzr.mk bzr repo.

Don't EXTRA_DIST this file. It is supposed to only live in git clones, not tarballs.
It serves no useful purpose in tarballs and clutters the build dir.

This file knows how to handle autoconf, automake, libtool, gtk-doc, gnome-doc-utils,
yelp.m4, mallard, intltool, gsettings, dejagnu, appdata, appstream.

This makefile provides the following targets:

* - all: "make all" will build .bzrignore target.
* - .bzrignore: make bzrignore file for the current dir. (As example)

Known Bugs: See https://bugs.launchpad.net/ignore-me