From 8cf2e7d53f5d2178c6949b478c3ac7c45a84b438 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Sat, 22 May 2010 11:26:49 +0100 Subject: [PATCH] Rationalise docs - get rid of README.notes --- README.notes | 62 --------------------------------------------------- README.states | 3 +++ defer.c | 11 +++++++++ innduct.8 | 10 ++++----- 4 files changed, 18 insertions(+), 68 deletions(-) delete mode 100644 README.notes diff --git a/README.notes b/README.notes deleted file mode 100644 index 1994bd2..0000000 --- a/README.notes +++ /dev/null @@ -1,62 +0,0 @@ -NEWSFEEDS - -Newsfeeds file entries should look like this: - host.name.of.site[/exclude,exclude,...]\ - :pattern,pattern...[/distribution,distribution...]\ - :Tf,Wnm - : -or - sitename[/exclude,exclude,...]\ - :pattern,pattern...[/distribution,distribution...]\ - :Tf,Wnm - :host.name.of.site - - -FILES - -Four files full of - token messageid -or might be blanked out - .... - -F site.name main feed file - opened/created, then written, by innd - read by duct - unlinked by duct - tokens blanked out by duct when processed - site.name_lock lock preventing multiple ducts - to hold lock must open,F_SETLK[W] - and then stat to check that locked file - still has name site.name_lock - holder of this lock is "duct" - (only) lockholder may remove the lockfile -D site.name_flushing temporary feed file during flush (or crash) - hardlink created by duct - unlinked by duct - site.name_defer 431'd articles, still being written, - created, written, used by duct - - site.name_backlog.. - 431'd articles, ready for innxmit or duct - created (link/mv) by duct - site.name_backlog (where does not - contain '#' or '~') eg - site.name_backlog.manual - anything the sysadmin likes (eg, feed files - from old feeds to be merged into this one) - created (link/mv) by admin - may be symlinks (in which case links - may be written through, but only links - will be removed. - - It is safe to remove backlog files manually, - if it's desired to throw away the backlog. - -Backlog files are also processed by innduct. We find the oldest -backlog file which is at least a certain amount old, and feed it -back into our processing. When every article in it has been read -and processed, we unlink it and look for another backlog file. - -If we don't have a backlog file that we're reading, we close the -defer file that we're writing and make it into a backlog file at -the first convenient opportunity. diff --git a/README.states b/README.states index 4676b30..4ee9daf 100644 --- a/README.states +++ b/README.states @@ -2,6 +2,9 @@ OVERALL STATES, defining interaction with innd: + F refers to the main feed file as written by innd + D refers to the flushing file _flushing + START | ,-->--. check F, D diff --git a/defer.c b/defer.c index 811907e..ba2b302 100644 --- a/defer.c +++ b/defer.c @@ -28,6 +28,17 @@ /*---------- defer and backlog files ----------*/ +/* + * Backlog files are also processed by innduct. We find the oldest + * backlog file which is at least a certain amount old, and feed it + * back into our processing. When every article in it has been read + * and processed, we unlink it and look for another backlog file. + * + * If we don't have a backlog file that we're reading, we close the + * defer file that we're writing and make it into a backlog file at + * the first convenient opportunity. + */ + void open_defer(void) { struct stat stab; diff --git a/innduct.8 b/innduct.8 index c2a6cef..a513252 100644 --- a/innduct.8 +++ b/innduct.8 @@ -535,12 +535,10 @@ by innduct, and will also be read, updated and removed by innduct. However you (the administrator) may also safely remove backlog files. .IP \fIfeedfile\fR_backlog\fIsomething\fR .IX Item "manual backlog file" -Batch file manually provided by the administrator. The file should be -complete and ready to process at the time it is renamed or hardlinked -to this name. innduct will then automatically find and read and -process it (including blanking out entries for processed articles) and -eventually remove it. \fIsomething\fR may not contain \fB#\fR \fB~\fR -or \fB/\fR. +Batch file manually provided by the administrator. innduct will +automatically find, read and process any file matching this pattern +(blanking out entries for processed articles) and eventually remove +it. \fIsomething\fR may not contain \fB#\fR \fB~\fR or \fB/\fR. .IP Be sure to have finished writing the file before you rename it to match the pattern \fIfeedfile\fR\fB_backlog\fR*, as otherwise innduct -- 2.30.2