Opened 11 years ago

Closed 11 years ago

#4682 defect closed fixed (fixed)

Documentation point to lore templates that don't exist

Reported by: lvh Owned by: lvh
Priority: normal Milestone:
Component: lore Keywords: documentation easy
Cc: jesstess Branch:
Author:

Description

lvh@bruichladdich:~/Development/twisted/twisted$ rgrep doc/howto/template.tpl . | grep -v historic
./doc/lore/howto/lore.xhtml:% lore --config template=doc/howto/template.tpl doc/howto/*.xhtml
./doc/core/development/policy/svn-dev.xhtml:./bin/lore/lore -p --config template=doc/howto/template.tpl doc/howto/*.xhtml
./doc/core/development/policy/svn-dev.xhtml:./bin/lore/lore -p --config template=doc/howto/template.tpl \

doc/howto/template.tpl doesn't actually exist anymore, it's doc/core/howto/template.tpl now.

Attachments (1)

lore-docfix-4682.diff (3.4 KB) - added by lvh 11 years ago.

Download all attachments as: .zip

Change History (6)

comment:1 Changed 11 years ago by lvh

Owner: changed from spiv to lvh

comment:2 Changed 11 years ago by lvh

I found some more places with this broken reference, I'll fix them while I'm at it:

lvh@bruichladdich:~/Development/twisted/lore-docfix-4682$ rgrep doc/howto . | grep -v historic | grep -v ChangeLog.Old
./doc/lore/howto/lore.xhtml:% lore --config template=doc/core/howto/template.tpl doc/howto/*.xhtml
./twisted/python/usage.py:or doc/howto/options.html in your Twisted directory.
./twisted/python/usage.py:    or doc/howto/options.html in your Twisted directory.
./twisted/internet/defer.py:    For more information about Deferreds, see doc/howto/core/defer.html or
./twisted/web/sux.py:    # fn = "/home/glyph/Projects/Twisted/doc/howto/ipc10paper.html"
./emacs/twisted-dev.el:  (with-cd (format "%s/doc/howto" twisted-dev-directory)

Changed 11 years ago by lvh

Attachment: lore-docfix-4682.diff added

comment:3 Changed 11 years ago by lvh

Keywords: review added
Owner: lvh deleted

When I run that command now, I get:

lvh@bruichladdich:~/Development/twisted/lore-docfix-4682$ rgrep doc/howto . | grep -v historic | grep -v ChangeLog.Old
./twisted/web/sux.py:    # fn = "/home/glyph/Projects/Twisted/doc/howto/ipc10paper.html"

But t.w.sux deserves its own ticket for the nasty things in its if __name__ == "__main__":.

Diff attached. Individual commits can be found at lp:~lvh/twisted/lore-docfix-4682

comment:4 Changed 11 years ago by jesstess

Cc: jesstess added
Keywords: review removed
Owner: set to lvh

What a great catch. Thanks for fixing these.

In

-    For more information about Deferreds, see doc/howto/core/defer.html or
+    For more information about Deferreds, see doc/core/howto/defer.html or

might as well switch to the xhtml reference like you do elsewhere.

Can you also bump the copyright on twisted/python/usage.py.

Other than that, looks great, please merge!

comment:5 Changed 11 years ago by lvh

Resolution: fixed
Status: newclosed

(In [30997]) Merge lore-docfix-4682: fix links to lore templates that don't exist.

Author: lvh Reviewer: jesstess Fixes: #4682

There were some references to doc/howto/template.tpl, which doesn't actually exist anymore, it's doc/core/howto/template.tpl now. There was an additional small link fix in the Lore docs.

Note: See TracTickets for help on using tickets.