unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
* [PATCH 0/2] reinstate README.html
@ 2014-12-22  1:50 Eric Wong
  2014-12-22  1:50 ` [PATCH 1/2] Documentation/txt2pre: support #fragments and ftp:// Eric Wong
  2014-12-22  1:50 ` [PATCH 2/2] doc: generate README.html instead of index.html Eric Wong
  0 siblings, 2 replies; 3+ messages in thread
From: Eric Wong @ 2014-12-22  1:50 UTC (permalink / raw)
  To: meta

Having README.html isn't very harmful to discoverability or
maintainability; but leave index.html ungenerated so HTTP
servers can generate directory indices.

Note: these patches apply to both ssoma.git and public-inbox.git

Eric Wong (2):
      Documentation/txt2pre: support #fragments and ftp://
      doc: generate README.html instead of index.html


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH 1/2] Documentation/txt2pre: support #fragments and ftp://
  2014-12-22  1:50 [PATCH 0/2] reinstate README.html Eric Wong
@ 2014-12-22  1:50 ` Eric Wong
  2014-12-22  1:50 ` [PATCH 2/2] doc: generate README.html instead of index.html Eric Wong
  1 sibling, 0 replies; 3+ messages in thread
From: Eric Wong @ 2014-12-22  1:50 UTC (permalink / raw)
  To: meta; +Cc: Eric Wong

Occasionally we'll use these for links.
---
 Documentation/txt2pre | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/txt2pre b/Documentation/txt2pre
index f84f9c0..0384a1d 100755
--- a/Documentation/txt2pre
+++ b/Documentation/txt2pre
@@ -17,7 +17,7 @@ my ($title) = ($str =~ /\A([^\n]+)/);
 # temporarily swap > for escape so our s!! to add href works.
 # there's probably a way to do this with only a single s!! ...
 $str =~ s!>!\e!g;
-$str =~ s!\b(https?://[\w+\+\&\?\.\%\;/-]+)!<a\nhref="$1"\n>$1</a>!g;
+$str =~ s!\b((ftp|https?)://[\w+\+\&\?\.\%\;/#-]+)!<a\nhref="$1"\n>$1</a>!g;
 $str =~ s!\e!&gt;!g; # swap escapes back to &gt;
 
 print '<html><head>',
-- 
EW


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH 2/2] doc: generate README.html instead of index.html
  2014-12-22  1:50 [PATCH 0/2] reinstate README.html Eric Wong
  2014-12-22  1:50 ` [PATCH 1/2] Documentation/txt2pre: support #fragments and ftp:// Eric Wong
@ 2014-12-22  1:50 ` Eric Wong
  1 sibling, 0 replies; 3+ messages in thread
From: Eric Wong @ 2014-12-22  1:50 UTC (permalink / raw)
  To: meta; +Cc: Eric Wong

This allows us to generate links without caring about discoverability
and remains reasonably WYSIWYG for folks editing our documentation in
their favorite $EDITOR
---
 Documentation/include.mk | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/Documentation/include.mk b/Documentation/include.mk
index c852ce1..162bf54 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -42,12 +42,10 @@ install-man: man
 txt2pre = ./Documentation/txt2pre < $< > $@+ && touch -r $< $@+ && mv $@+ $@
 txt = INSTALL README COPYING
 
-INSTALL.html: INSTALL
-	$(txt2pre)
-index.html: README
+%.html: %
 	$(txt2pre)
 
-docs_html := INSTALL.html
+docs_html := $(addsuffix .html, $(txt))
 html: $(docs_html)
 gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
 rsync_docs := $(gz_docs) $(docs) $(txt) $(docs_html)
-- 
EW


^ permalink raw reply related	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2014-12-22  1:50 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-12-22  1:50 [PATCH 0/2] reinstate README.html Eric Wong
2014-12-22  1:50 ` [PATCH 1/2] Documentation/txt2pre: support #fragments and ftp:// Eric Wong
2014-12-22  1:50 ` [PATCH 2/2] doc: generate README.html instead of index.html Eric Wong

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).