user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
Search results ordered by [date|relevance]  view[summary|nested|Atom feed]
thread overview below | download mbox.gz: |
* [PATCH 2/4] doc: remove .x/ subdirectory for Xapian manpages
  2020-02-06  4:03  6% [PATCH 0/4] doc: data flow graph and doc linkification Eric Wong
@ 2020-02-06  4:03  7% ` Eric Wong
  0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2020-02-06  4:03 UTC (permalink / raw)
  To: meta

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
---
 Documentation/.gitignore | 2 +-
 Documentation/include.mk | 3 ---
 Makefile.PL              | 6 +++---
 3 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/Documentation/.gitignore b/Documentation/.gitignore
index f26169ac..92510039 100644
--- a/Documentation/.gitignore
+++ b/Documentation/.gitignore
@@ -1,4 +1,4 @@
 /public-inbox-*.txt
 /public-inbox.cgi.txt
 /standards.txt
-/.x
+/.*.txt
diff --git a/Documentation/include.mk b/Documentation/include.mk
index 41de0a72..8c5f3ca8 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -89,9 +89,6 @@ check :: NEWS .NEWS.atom.check NEWS.html
 
 html: $(docs_html)
 
-Documentation/.x:
-	mkdir -p $@
-
 doc: $(docs)
 
 %.gz: %
diff --git a/Makefile.PL b/Makefile.PL
index 59874170..8f1bc4b4 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -71,10 +71,10 @@ $v->{rsync_docs} = [ @{$v->{gz_docs}}, @{$v->{docs}},
 # external manpages which we host ourselves, since some packages
 # (currently just Xapian) doesn't host manpages themselves.
 my @xman = qw(copydatabase.1 xapian-compact.1);
-$v->{xdocs} = [ map { "Documentation/.x/.$_.txt" } @xman ];
-$v->{xdocs_html} = [ map { "Documentation/.x/.$_.html" } @xman ];
+$v->{xdocs} = [ map { "Documentation/.$_.txt" } @xman ];
+$v->{xdocs_html} = [ map { "Documentation/.$_.html" } @xman ];
 for (@{$v->{xdocs}}) {
-	$t->{"$_ : | Documentation/.x"} = [
+	$t->{"$_:"} = [
 		'$(PERL) -w Documentation/extman.perl $@ >$@+',
 		'mv $@+ $@'
 	];

^ permalink raw reply	[relevance 7%]

* [PATCH 0/4] doc: data flow graph and doc linkification
@ 2020-02-06  4:03  6% Eric Wong
  2020-02-06  4:03  7% ` [PATCH 2/4] doc: remove .x/ subdirectory for Xapian manpages Eric Wong
  0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2020-02-06  4:03 UTC (permalink / raw)
  To: meta

A couple of minor doc improvements.  Hopefully the flow graph
will make things easier-to-understand for new users.

And the txt2pre changes are a precursor to configurable
linkification in the WWW interface for email.

Eric Wong (4):
  doc: add data flow diagram using Graph::Easy
  doc: remove .x/ subdirectory for Xapian manpages
  doc: txt2pre: auto-linkify manpage references
  doc: v1: add a reference to git-filter-repo(1), too

 Documentation/.gitignore                 |  2 +-
 Documentation/flow.ge                    | 27 ++++++++
 Documentation/flow.txt                   | 32 +++++++++
 Documentation/include.mk                 | 21 ++++--
 Documentation/public-inbox-compact.pod   |  3 +-
 Documentation/public-inbox-edit.pod      |  2 +-
 Documentation/public-inbox-v1-format.pod |  3 +-
 Documentation/public-inbox-xcpdb.pod     |  4 +-
 Documentation/txt2pre                    | 88 +++++++++++++++++++++++-
 Makefile.PL                              |  7 +-
 10 files changed, 173 insertions(+), 16 deletions(-)
 create mode 100644 Documentation/flow.ge
 create mode 100644 Documentation/flow.txt


^ permalink raw reply	[relevance 6%]

Results 1-2 of 2 | reverse | sort options + mbox downloads above
-- links below jump to the message on this page --
2020-02-06  4:03  6% [PATCH 0/4] doc: data flow graph and doc linkification Eric Wong
2020-02-06  4:03  7% ` [PATCH 2/4] doc: remove .x/ subdirectory for Xapian manpages Eric Wong

Code repositories for project(s) associated with this public inbox

	https://80x24.org/public-inbox.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).