1 After applying this patch and running configure, you MUST run this
6 This patch adds the ability to merge rules into your excludes/includes
7 using a ". FILE" idiom. If you specify a name without slashes, that
8 filename will be looked for in every subdirectory that rsync visits,
9 and the rules found in that subdirectory's file will affect that dir
10 and its subdirectories.
14 rsync -av --exclude='. .excl' from/ to
16 The above will look for a file named ".excl" in every directory of the
17 hierarchy that rsync visits, and it will exclude (by default) names
18 based on the rules found therein. If one of the .excl files contains
26 Then the file ".excl2" will also be read in the current dir, and all
27 subdirs of the current dir. The file ".excl3" would just be read in
28 for the current dir because its name contained a slash.
32 --- exclude.c 21 May 2004 09:59:49 -0000 1.81
33 +++ exclude.c 21 May 2004 23:49:03 -0000
34 @@ -30,13 +30,56 @@ extern int verbose;
39 +extern int sanitize_paths;
41 extern char curr_dir[];
43 struct exclude_list_struct exclude_list = { 0, 0, "" };
44 -struct exclude_list_struct local_exclude_list = { 0, 0, "per-dir .cvsignore " };
45 struct exclude_list_struct server_exclude_list = { 0, 0, "server " };
46 char *exclude_path_prefix = NULL;
47 +struct exclude_struct **mergelist_parents;
48 +int mergelist_cnt = 0;
49 +int mergelist_size = 0;
51 +struct mergelist_save_struct {
52 + struct exclude_list_struct *array;
56 +static char dirbuf[MAXPATHLEN];
57 +static unsigned int dirbuf_offset = 0;
59 +/* Each exclude_list_struct describes a singly-linked list by keeping track
60 + * of both the head and tail pointers. The list is slightly unusual in that
61 + * a parent-dir's content can be appended to the end of the local list in a
62 + * special way: the last item in the local list has its "next" pointer set
63 + * to point to the inherited list, but the local list's tail pointer points
64 + * at the end of the local list. Thus, if the local list is empty, the head
65 + * will be pointing at the inherited content but the tail will be NULL. To
66 + * help you visualize this, here are the possible list arrangements:
68 + * Completely Empty Local Content Only
69 + * ================================== ====================================
70 + * head -> NULL head -> Local1 -> Local2 -> NULL
71 + * tail -> NULL tail -------------^
73 + * Inherited Content Only Both Local and Inherited Content
74 + * ================================== ====================================
75 + * head -> Parent1 -> Parent2 -> NULL head -> L1 -> L2 -> P1 -> P2 -> NULL
76 + * tail -> NULL tail ---------^
78 + * This means that anyone wanting to traverse the whole list to USE it just
79 + * needs to start at the head and use the "next" pointers until it goes
80 + * NULL. To add new local content, we insert the item after the tail item
81 + * and update the tail (obviously, if "tail" was NULL, we insert it at the
82 + * head). To clear the local list, WE MUST NOT FREE THE INHERITED CONTENT
83 + * because it is shared between the current list and our parent list(s).
84 + * The easiest way to handle this is to simply truncate the list after the
85 + * tail item and then free the local list from the head. When inheriting
86 + * the list for a new local dir, we just save off the exclude_list_struct
87 + * values (so we can pop back to them later) and set the tail to NULL.
90 /** Build an exclude structure given an exclude pattern. */
91 static void make_exclude(struct exclude_list_struct *listp, const char *pat,
92 @@ -46,6 +89,24 @@ static void make_exclude(struct exclude_
96 + if (mflags & MATCHFLG_MERGE_FILE) {
98 + /* If the local include file was already mentioned, don't
100 + for (i = 0; i < mergelist_cnt; i++) {
101 + struct exclude_struct *ex = mergelist_parents[i];
102 + if (strlen(ex->pattern) == pat_len
103 + && memcmp(ex->pattern, pat, pat_len) == 0)
106 + if ((pat_len == 10 || (pat_len > 10 && pat[pat_len-11] == '/'))
107 + && strncmp(pat+pat_len-10, ".cvsignore", 10) == 0) {
108 + mflags |= MATCHFLG_CVSIGNORE;
109 + mflags &= ~MATCHFLG_INCLUDE;
111 + mflags &= ~MATCHFLG_CVSIGNORE;
114 ret = new(struct exclude_struct);
116 out_of_memory("make_exclude");
117 @@ -81,14 +142,36 @@ static void make_exclude(struct exclude_
118 mflags |= MATCHFLG_DIRECTORY;
121 - for (cp = ret->pattern; (cp = strchr(cp, '/')) != NULL; cp++)
123 + if (mflags & MATCHFLG_MERGE_FILE) {
124 + struct exclude_list_struct *lp
125 + = new_array(struct exclude_list_struct, 1);
127 + out_of_memory("make_exclude");
128 + lp->head = lp->tail = NULL;
129 + if (asprintf(&lp->debug_type, "per-dir %s ", ret->pattern) < 0)
130 + out_of_memory("make_exclude");
131 + ret->u.mergelist = lp;
132 + if (mergelist_cnt == mergelist_size) {
133 + mergelist_size += 5;
134 + mergelist_parents = realloc_array(mergelist_parents,
135 + struct exclude_struct *,
137 + if (!mergelist_parents)
138 + out_of_memory("make_exclude");
140 + mergelist_parents[mergelist_cnt++] = ret;
142 + for (cp = ret->pattern; (cp = strchr(cp, '/')) != NULL; cp++)
143 + ret->u.slash_cnt++;
146 ret->match_flags = mflags;
149 + if (!listp->tail) {
150 + ret->next = listp->head;
151 listp->head = listp->tail = ret;
154 + ret->next = listp->tail->next;
155 listp->tail->next = ret;
158 @@ -96,22 +179,115 @@ static void make_exclude(struct exclude_
160 static void free_exclude(struct exclude_struct *ex)
162 + if (ex->match_flags & MATCHFLG_MERGE_FILE) {
163 + free(ex->u.mergelist->debug_type);
164 + free(ex->u.mergelist);
170 -void clear_exclude_list(struct exclude_list_struct *listp)
171 +static void clear_exclude_list(struct exclude_list_struct *listp)
173 - struct exclude_struct *ent, *next;
175 - for (ent = listp->head; ent; ent = next) {
179 + struct exclude_struct *ent, *next;
180 + /* Truncate any inherited items from the local list. */
181 + listp->tail->next = NULL;
182 + for (ent = listp->head; ent; ent = next) {
188 listp->head = listp->tail = NULL;
191 +void *push_local_excludes(char *fname, unsigned int offset)
193 + struct mergelist_save_struct *push;
194 + struct exclude_list_struct *ap;
197 + /* Make it easy to construct the full path for a merge-file that was
198 + * specified with a relative path by saving off the current dir. */
199 + memcpy(dirbuf, fname, offset);
200 + dirbuf_offset = offset;
202 + if (!(push = new_array(struct mergelist_save_struct, 1)))
203 + out_of_memory("push_local_excludes");
205 + push->count = mergelist_cnt;
206 + push->array = new_array(struct exclude_list_struct, mergelist_cnt);
208 + out_of_memory("push_local_excludes");
210 + for (i = 0, ap = push->array; i < mergelist_cnt; i++) {
211 + memcpy(ap++, mergelist_parents[i]->u.mergelist,
212 + sizeof (struct exclude_list_struct));
215 + /* Note: add_exclude_file() might increase mergelist_cnt, so keep
216 + * this loop separate from the above loop. */
217 + for (i = 0; i < mergelist_cnt; i++) {
218 + struct exclude_struct *ex = mergelist_parents[i];
219 + struct exclude_list_struct *lp = ex->u.mergelist;
223 + rprintf(FINFO, "[%s] pushing %sexclude list\n",
224 + who_am_i(), lp->debug_type);
227 + if (ex->match_flags & MATCHFLG_CVSIGNORE) {
228 + lp->head = NULL; /* CVS doesn't inherit rules. */
229 + flags = XFLG_WORD_SPLIT | XFLG_WORDS_ONLY;
231 + flags = ex->match_flags & MATCHFLG_INCLUDE
232 + ? XFLG_DEF_INCLUDE : 0;
234 + lp->tail = NULL; /* Switch any local rules to inherited. */
235 + if (strlcpy(dirbuf + dirbuf_offset, ex->pattern,
236 + MAXPATHLEN - dirbuf_offset) < MAXPATHLEN - dirbuf_offset)
237 + add_exclude_file(lp, dirbuf, flags);
239 + io_error |= IOERR_GENERAL;
241 + "cannot add local excludes in long-named directory %s\n",
242 + full_fname(dirbuf));
246 + return (void*)push;
249 +void pop_local_excludes(void *mem)
251 + struct mergelist_save_struct *pop = (struct mergelist_save_struct*)mem;
252 + struct exclude_list_struct *ap;
255 + for (i = 0; i < mergelist_cnt; i++) {
256 + struct exclude_struct *ex = mergelist_parents[i];
257 + struct exclude_list_struct *lp = ex->u.mergelist;
260 + rprintf(FINFO, "[%s] popping %sexclude list\n",
261 + who_am_i(), lp->debug_type);
264 + clear_exclude_list(lp);
267 + mergelist_cnt = pop->count;
268 + for (i = 0, ap = pop->array; i < mergelist_cnt; i++) {
269 + memcpy(mergelist_parents[i]->u.mergelist, ap++,
270 + sizeof (struct exclude_list_struct));
277 static int check_one_exclude(char *name, struct exclude_struct *ex,
280 @@ -122,7 +298,7 @@ static int check_one_exclude(char *name,
281 /* If the pattern does not have any slashes AND it does not have
282 * a "**" (which could match a slash), then we just match the
283 * name portion of the path. */
284 - if (!ex->slash_cnt && !(ex->match_flags & MATCHFLG_WILD2)) {
285 + if (!ex->u.slash_cnt && !(ex->match_flags & MATCHFLG_WILD2)) {
286 if ((p = strrchr(name,'/')) != NULL)
289 @@ -148,9 +324,9 @@ static int check_one_exclude(char *name,
290 if (ex->match_flags & MATCHFLG_WILD) {
291 /* A non-anchored match with an infix slash and no "**"
292 * needs to match the last slash_cnt+1 name elements. */
293 - if (!match_start && ex->slash_cnt
294 + if (!match_start && ex->u.slash_cnt
295 && !(ex->match_flags & MATCHFLG_WILD2)) {
296 - int cnt = ex->slash_cnt + 1;
297 + int cnt = ex->u.slash_cnt + 1;
298 for (p = name + strlen(name) - 1; p >= name; p--) {
299 if (*p == '/' && !--cnt)
301 @@ -221,6 +397,13 @@ int check_exclude(struct exclude_list_st
302 struct exclude_struct *ent;
304 for (ent = listp->head; ent; ent = ent->next) {
305 + if (ent->match_flags & MATCHFLG_MERGE_FILE) {
306 + int rc = check_exclude(ent->u.mergelist, name,
312 if (check_one_exclude(name, ent, name_is_dir)) {
313 report_exclude_result(name, ent, name_is_dir,
315 @@ -254,11 +437,16 @@ static const char *get_exclude_tok(const
319 - /* Is this a '+' or '-' followed by a space (not whitespace)? */
320 + /* Is this a +/-/. followed by a space (not whitespace)? */
321 if (!(xflags & XFLG_WORDS_ONLY)
322 - && (*s == '-' || *s == '+') && s[1] == ' ') {
323 + && (*s == '-' || *s == '+' || *s == '.') && s[1] == ' ') {
325 mflags |= MATCHFLG_INCLUDE;
326 + else if (*s == '.') {
327 + mflags |= MATCHFLG_MERGE_FILE;
328 + if (xflags & XFLG_DEF_INCLUDE)
329 + mflags |= MATCHFLG_INCLUDE;
332 } else if (xflags & XFLG_DEF_INCLUDE)
333 mflags |= MATCHFLG_INCLUDE;
334 @@ -307,11 +495,42 @@ void add_exclude(struct exclude_list_str
338 + if (mflags & MATCHFLG_MERGE_FILE) {
339 + char name[MAXPATHLEN];
340 + if (pat_len >= sizeof name) {
342 + "merge filename too long: %s\n", cp);
345 + strlcpy(name, cp, pat_len+1);
346 + if (strchr(name, '/') != NULL) {
347 + if (sanitize_paths)
348 + sanitize_path(name, curr_dir);
352 + if (strlcpy(dirbuf + dirbuf_offset,
353 + name, MAXPATHLEN - dirbuf_offset)
354 + >= MAXPATHLEN - dirbuf_offset) {
356 + "merge filename too long: %s...\n",
362 + add_exclude_file(listp, cp,
363 + xflags | XFLG_FATAL_ERRORS);
368 make_exclude(listp, cp, pat_len, mflags);
371 - rprintf(FINFO, "[%s] add_exclude(%.*s, %s%sclude)\n",
372 + rprintf(FINFO, "[%s] add_exclude(%.*s, %s%s%sclude)\n",
373 who_am_i(), (int)pat_len, cp, listp->debug_type,
374 + mflags & MATCHFLG_MERGE_FILE ? "FILE " : "",
375 mflags & MATCHFLG_INCLUDE ? "in" : "ex");
378 @@ -403,7 +622,11 @@ void send_exclude_list(int f)
379 if (ent->match_flags & MATCHFLG_INCLUDE) {
381 write_buf(f, "+ ", 2);
382 - } else if ((*p == '-' || *p == '+') && p[1] == ' ') {
383 + } else if (ent->match_flags & MATCHFLG_MERGE_FILE) {
384 + write_int(f, l + 2);
385 + write_buf(f, ". ", 2);
386 + } else if ((*p == '-' || *p == '+' || *p == '.')
389 write_buf(f, "- ", 2);
391 @@ -444,6 +667,7 @@ void add_cvs_excludes(void)
392 char fname[MAXPATHLEN];
395 + add_exclude(&exclude_list, ". .cvsignore", 0);
396 add_exclude(&exclude_list, default_cvsignore,
397 XFLG_WORD_SPLIT | XFLG_WORDS_ONLY);
399 --- flist.c 21 May 2004 23:22:14 -0000 1.225
400 +++ flist.c 21 May 2004 23:49:04 -0000
401 @@ -39,8 +39,6 @@ extern int module_id;
402 extern int ignore_errors;
403 extern int numeric_ids;
405 -extern int cvs_exclude;
408 extern char curr_dir[MAXPATHLEN];
409 extern char *files_from;
410 @@ -65,7 +63,6 @@ extern int write_batch;
412 extern struct exclude_list_struct exclude_list;
413 extern struct exclude_list_struct server_exclude_list;
414 -extern struct exclude_list_struct local_exclude_list;
418 @@ -210,8 +207,6 @@ int link_stat(const char *path, STRUCT_S
420 static int check_exclude_file(char *fname, int is_dir, int exclude_level)
424 #if 0 /* This currently never happens, so avoid a useless compare. */
425 if (exclude_level == NO_EXCLUDES)
427 @@ -233,10 +228,7 @@ static int check_exclude_file(char *fnam
428 if (exclude_level != ALL_EXCLUDES)
430 if (exclude_list.head
431 - && (rc = check_exclude(&exclude_list, fname, is_dir)) != 0)
433 - if (local_exclude_list.head
434 - && check_exclude(&local_exclude_list, fname, is_dir) < 0)
435 + && check_exclude(&exclude_list, fname, is_dir) < 0)
439 @@ -942,15 +934,7 @@ void send_file_name(int f, struct file_l
441 if (recursive && S_ISDIR(file->mode)
442 && !(file->flags & FLAG_MOUNT_POINT)) {
443 - struct exclude_list_struct last_list = local_exclude_list;
444 - local_exclude_list.head = local_exclude_list.tail = NULL;
445 send_directory(f, flist, f_name_to(file, fbuf));
447 - rprintf(FINFO, "[%s] popping %sexclude list\n",
448 - who_am_i(), local_exclude_list.debug_type);
450 - clear_exclude_list(&local_exclude_list);
451 - local_exclude_list = last_list;
455 @@ -961,6 +945,7 @@ static void send_directory(int f, struct
457 char fname[MAXPATHLEN];
459 + void *save_excludes;
463 @@ -984,18 +969,7 @@ static void send_directory(int f, struct
468 - if (strlcpy(p, ".cvsignore", MAXPATHLEN - offset)
469 - < MAXPATHLEN - offset) {
470 - add_exclude_file(&local_exclude_list, fname,
471 - XFLG_WORD_SPLIT | XFLG_WORDS_ONLY);
473 - io_error |= IOERR_GENERAL;
475 - "cannot cvs-exclude in long-named directory %s\n",
476 - full_fname(fname));
479 + save_excludes = push_local_excludes(fname, offset);
481 for (errno = 0, di = readdir(d); di; errno = 0, di = readdir(d)) {
482 char *dname = d_name(di);
483 @@ -1016,6 +990,8 @@ static void send_directory(int f, struct
484 rsyserr(FERROR, errno, "readdir(%s)", dir);
487 + pop_local_excludes(save_excludes);
492 --- rsync.h 16 May 2004 07:28:24 -0000 1.204
493 +++ rsync.h 21 May 2004 23:49:05 -0000
494 @@ -496,11 +496,16 @@ struct map_struct {
495 #define MATCHFLG_INCLUDE (1<<4) /* this is an include, not an exclude */
496 #define MATCHFLG_DIRECTORY (1<<5) /* this matches only directories */
497 #define MATCHFLG_CLEAR_LIST (1<<6) /* this item is the "!" token */
498 +#define MATCHFLG_MERGE_FILE (1<<7) /* specifies a file to merge */
499 +#define MATCHFLG_CVSIGNORE (1<<8) /* parse this as a .cvsignore file */
500 struct exclude_struct {
501 struct exclude_struct *next;
503 unsigned int match_flags;
507 + struct exclude_list_struct *mergelist;
511 struct exclude_list_struct {
512 --- rsync.yo 21 May 2004 09:44:32 -0000 1.170
513 +++ rsync.yo 21 May 2004 23:49:05 -0000
514 @@ -1090,6 +1090,72 @@ itemize(
515 it would be excluded by the "*")
518 +manpagesection(MERGING EXCLUDE FILES)
520 +You can merge whole files into an exclude file using a rule that starts
521 +with a ". " (a dot followed by a space) and has a filename in place of the
522 +pattern. There are two types of merge rules, single-instance and
526 + it() If the filename has no slashes in it, it is a per-directory merge;
527 + rsync scans every directory that it traverses for the named file, merging
528 + its contents (when it exists) file at the start of this per-directory
529 + sub-list (subdirectories inherit the contents of their parent directories
530 + by default, and each subdirectory's rules have precedence over the parent
531 + directory's rules).
533 + it() If a filename has a slash in it, it is a single-instance merge; the
534 + named file's contents will be merged into the current exclude file,
535 + replacing the merge rule. Thus, you should use the name ./foo instead of
536 + foo if you don't want to scan for "foo" in all the subdirectories of the
540 +Note also that you can eliminate all the inherited rules for the current
541 +per-directory ruleset by putting the list-clearing token (!) in the file.
542 +This only clears the rules for the current per-directory sub-list (up
543 +through the ! token) and only for the current directory and its
546 +Here's an example exclude file (which you'd specify via the normal
547 +--exclude-from option):
550 + . /home/user/.global_excludes
557 +This will merge the contents of the /home/user/.global_excludes file at the
558 +start of the list and also turns the ".excl" filename into a per-directory
559 +exclude file whose local contents will be merged into the list in place of
562 +Additionally, you can affect where the --cvs-exclude (-C) option's
563 +inclusion of a per-directory .cvsignore file gets placed into your rules by
564 +adding an explicit merge rule for ".cvsignore". For instance, specifying
568 + rsync -avC --exclude='. .cvsignore' --exclude-from=foo a/ b
571 +will merge all the per-directory .cvsignore rules at the start of your list
572 +rather than at the end. This allows their dir-specific rules to supersede
573 +your rules instead of being subservient to them. (The global rules taken
574 +from the $HOME/.cvsignore file and from $CVSIGNORE are not affected by
577 +Note also that the parsing of any merge-file named ".cvsignore" is always
578 +done in a CVS-compatible manner (even if -C wasn't specified) -- i.e. the
579 +rules are always exclude rules (even when specified by an include option),
580 +they are split on whitespace, no special prefixes or list-clearing tokens
581 +are honored, and (for per-directory files) subdirectories don't inherit the
582 +parent directory's rules.
584 manpagesection(BATCH MODE)
586 bf(Note:) Batch mode should be considered experimental in this version