Date | Commit message (Collapse) |
|
I didn't wait until September to do it, this year!
|
|
There's no need to keep Xapian manpage renderings in a separate
subdirectory, after all.
Eliminating this difference between the local FS and URL path
will allow relative URLs to the Xapian manpages in our local
HTML documentation to work smoothly, since there was never any
".x/" path component for files served from public-inbox.org
|
|
Maybe this can make it easier for new and potential
users to understand what's going on.
|
|
Repeatedly rebuilding `NEWS' because the mtime of `NEWS'
is synched to the latest release .eml is a bit annoying,
but necessary to save bandwidth for the website.
So we'll also update the mtime of the source .eml file when
reading them. It's kinda gross to be setting mtimes of source
.eml files in Documentation/RelNotes/, but I can't think of
anything better at the moment...
|
|
mknews doesn't require any optional dependencies a user wouldn't
normally have. We can save storage and bandwidth costs by
letting cgit serve the exact tar.gz which "git archive | gzip -n"
generates.
|
|
We can replace the GNU-isms for building docs with Perl5
equivalents. The only downside is the resulting Makefile
gets larger, but that's the price of portability.
|
|
We can create a stamp to avoid rerunning the check unless
NEWS.atom changes (and it will, soon, I hope :>).
|
|
We can keep a stamp around if the corresponding manpage hasn't
changed to avoid re-running man(1) and awk(1).
|
|
|
|
Since MANIFEST is tied to files tracked by git, adding generated
files such as NEWS to that is more effort than its worth (esp.
when I'm wondering if MakeMaker is useful compared to only using
GNU make).
I also have trouble reading CamelCase, so lower-case names
are nicer and more consistent with previous releases
(which were all generated with "git archive"); but did not
include NEWS.
|
|
Yet another case of documenting things which should NOT be used :>
|
|
Tools intended for end users need manpages, and doubly so
to convince potential users NOT to use them :)
|
|
Tools intended for end users need manpages.
|
|
I need to remove all the generated documentation files
before running "git-set-file-times" for rsync to our
website.
|
|
man(1) on FreeBSD supports pathnames as operands just
fine, so there's hope other BSDs follow suit and we
can enable this check target everywhere.
|
|
That's the environment documented in ncurses(3) and man(1) from
the man-db.nongnu.org distribution of man.
|
|
man(1) on FreeBSD unconditionally emits backspace characters
for the bold effect despite its output being piped to awk(1).
Also tested with the man-db.nongnu.org version provided with
Debian (and presumably most other Linux systems).
|
|
This should prevent future documentation changes from exceeding
the limit of standard terminals.
|
|
We should also note that the package "xmlstarlet" on FreeBSD
installs a command "xml" (but not "xmlstarlet") on FreeBSD.
|
|
It was causing unnecessary rebuilds of NEWS* files
|
|
We shouldn't need installed modules to generate NEWS* files.
|
|
We'll use our Documentation/RelNotes directory and internal APIs
to generate these files for website use (the website should be
completely reproducible).
|
|
This old command was lacking a manpage, so (finally) create one.
|
|
GNU make has order-only prerequisites, so use it to avoid
redundant mkdir(1) calls since our homepage requires GNU
make to build anyways.
|
|
* origin/edit:
edit: unlink temporary file when done
v2writable: replace: kill git processes before reindexing
edit: drop unwanted headers before noop check
edit|purge: improve output on rewrites
edit: new tool to perform edits
doc: document the --prune option for -index
admin: expose ->config
AdminEdit: move editability checks from -purge
admin: beef up resolve_inboxes to handle purge options
purge: start moving common options to AdminEdit module
admin: remove warning arg for unconfigured inboxes
v2writable: implement ->replace call
import: switch to "replace_oids" interface for purge
import: extract_author_info becomes extract_commit_info
v2writable: consolidate overview and indexing call
|
|
It's been written for over a year, but I forgot to include
it in the build so it did not get installed or put on the site.
|
|
|
|
This wrapper around V2Writable->replace provides a user-interface
for editing messages as single-message mboxes (or the raw text
via $EDITOR).
|
|
They're nowhere to be found on Xapian.org, and links to
external services are either too long (for manpages.debian.org)
or have privacy-invasive tracking JS on them.
|
|
Otherwise timestamps for .html files get screwed up, too;
and that hurts caching.
|
|
It's not critical, but it's nice to have for cache-friendliness
(otherwise I would not have written it :P)
I guess I should follow up on getting it into 'git contrib/':
https://public-inbox.org/git/20100702033709.GA6818@burratino/
|
|
copydatabase(1) is an existing Xapian tool which is the
recommended way to upgrade existing DBs to the latest Xapian
database format (currently "glass" for stable/released
versions). Our use of Xapian relies on preserving document IDs,
so we'll wrap it like we do xapian-compact(1) and use the
"--no-renumber" switch.
I could not name the tool "public-inbox-copydatabase" since it
would be ambiguous as to which DB it's actually copying. So, I
abbreviated the suffix to "xcpdb" (Xapian CoPy DataBase), which
I hope is acceptable and unambiguous.
|
|
Preventative measures; since marketing is almost always annoying
to me. And trying to avoid unintended consequences.
|
|
And document that we still have GNU-isms in that
include.mk Makefile (and may continue to do so).
Finally, take advantage of GNU-isms to warn users
to run "gmake" to build all manpages.
|
|
We can fix the redundant rule in include.mk which causes
make(1) on FreeBSD to complain; but HTML docs will likely
still require GNU make.
|
|
Incomplete at the moment, but this ought to be a handy reference
for both implementers and users alike.
|
|
Remove confusing documentation around ssoma now that we
have NNTP and downloadable mbox support.
Only lightly-checked for grammar and speling, and not yet
formatting. Edits, corrections and addendums expected :>
|
|
Using update-copyrights from gnulib
While we're at it, use the SPDX identifier for AGPL-3.0+ to
ease mechanical processing.
|
|
This will hopefully increase visibility of some archives.
|
|
We have these manpages, and will always have them, so stop
trying to pretend we're doing something about maintainability,
here.
|
|
And include it into the build + website
|
|
Hopefully more folks can download and run public-inbox,
nowadays.
|
|
This will be important as we will have more of them.
|
|
This will allow reasonable titles to be generated for
manpages.
|
|
Since this is bundled with the source, we might as well use
internal APIs to avoid having duplicate code (and bugs :P)
|
|
We want the pod2man(1) executable for handling certain
options. Also, use the correct year while we're at it :P
|
|
This makes us closer to git.git style (though I'm not quite sure
why we do this...)
|
|
Also, at least add one of the Tor mirrors (the rest will
be discoverable through the mirrors themselves).
|
|
This is probably trivial enough to be final?
|
|
This project is currently implemented in Perl, and pod2man is
probably more common among potential users and developers of
this project.
|