git@vger.kernel.org mailing list mirror (one of many)
 help / Atom feed
* [PATCH 0/6] fix broken links in Documentation/
@ 2017-04-20 20:32 Jeff King
  2017-04-20 20:32 ` [PATCH 1/6] doc: use https links to avoid http redirect Jeff King
                   ` (5 more replies)
  0 siblings, 6 replies; 7+ messages in thread
From: Jeff King @ 2017-04-20 20:32 UTC (permalink / raw)
  To: git

I've been looking at running an automated link-checker on git-scm.com.
But as it hosts HTML rendered from our Documentation/ directory, it
inherits any broken links that we have here. :)

This series fixes all the issues I could find.

  [1/6]: doc: use https links to avoid http redirect
  [2/6]: doc: replace or.cz gitwiki link with git.wiki.kernel.org
  [3/6]: gitcore-tutorial: update broken link
  [4/6]: docs/archimport: quote sourcecontrol.net reference
  [5/6]: docs/bisect-lk2009: update nist report link
  [6/6]: docs/bisect-lk2009: update java code conventions link

 Documentation/git-archimport.txt                 |  2 +-
 Documentation/git-bisect-lk2009.txt              | 14 +++++++-------
 Documentation/git-tools.txt                      |  2 +-
 Documentation/gitcore-tutorial.txt               |  2 +-
 Documentation/gitweb.conf.txt                    |  4 ++--
 Documentation/howto/rebuild-from-update-hook.txt |  4 ++--
 6 files changed, 14 insertions(+), 14 deletions(-)

-Peff

^ permalink raw reply	[flat|threaded] 7+ messages in thread

* [PATCH 1/6] doc: use https links to avoid http redirect
  2017-04-20 20:32 [PATCH 0/6] fix broken links in Documentation/ Jeff King
@ 2017-04-20 20:32 ` Jeff King
  2017-04-20 20:32 ` [PATCH 2/6] doc: replace or.cz gitwiki link with git.wiki.kernel.org Jeff King
                   ` (4 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: Jeff King @ 2017-04-20 20:32 UTC (permalink / raw)
  To: git

Many sites these days unconditionally redirect http requests
to their https equivalents. Let's make our links https in
the first place to save the client a redirect.

Signed-off-by: Jeff King <peff@peff.net>
---
 Documentation/git-bisect-lk2009.txt              | 10 +++++-----
 Documentation/gitweb.conf.txt                    |  4 ++--
 Documentation/howto/rebuild-from-update-hook.txt |  4 ++--
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index e015f5b3c..716d66d43 100644
--- a/Documentation/git-bisect-lk2009.txt
+++ b/Documentation/git-bisect-lk2009.txt
@@ -1349,10 +1349,10 @@ References
 
 - [[[1]]] http://www.nist.gov/public_affairs/releases/n02-10.htm['Software Errors Cost U.S. Economy $59.5 Billion Annually'. Nist News Release.]
 - [[[2]]] http://java.sun.com/docs/codeconv/html/CodeConventions.doc.html#16712['Code Conventions for the Java Programming Language'. Sun Microsystems.]
-- [[[3]]] http://en.wikipedia.org/wiki/Software_maintenance['Software maintenance'. Wikipedia.]
+- [[[3]]] https://en.wikipedia.org/wiki/Software_maintenance['Software maintenance'. Wikipedia.]
 - [[[4]]] http://article.gmane.org/gmane.comp.version-control.git/45195/[Junio C Hamano. 'Automated bisect success story'. Gmane.]
-- [[[5]]] http://lwn.net/Articles/317154/[Christian Couder. 'Fully automated bisecting with "git bisect run"'. LWN.net.]
-- [[[6]]] http://lwn.net/Articles/277872/[Jonathan Corbet. 'Bisection divides users and developers'. LWN.net.]
+- [[[5]]] https://lwn.net/Articles/317154/[Christian Couder. 'Fully automated bisecting with "git bisect run"'. LWN.net.]
+- [[[6]]] https://lwn.net/Articles/277872/[Jonathan Corbet. 'Bisection divides users and developers'. LWN.net.]
 - [[[7]]] http://article.gmane.org/gmane.linux.scsi/36652/[Ingo Molnar. 'Re: BUG 2.6.23-rc3 can't see sd partitions on Alpha'. Gmane.]
-- [[[8]]] http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html[Junio C Hamano and the git-list. 'git-bisect(1) Manual Page'. Linux Kernel Archives.]
-- [[[9]]] http://github.com/Ealdwulf/bbchop[Ealdwulf. 'bbchop'. GitHub.]
+- [[[8]]] https://www.kernel.org/pub/software/scm/git/docs/git-bisect.html[Junio C Hamano and the git-list. 'git-bisect(1) Manual Page'. Linux Kernel Archives.]
+- [[[9]]] https://github.com/Ealdwulf/bbchop[Ealdwulf. 'bbchop'. GitHub.]
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index e6320891b..9c8982ec9 100644
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -368,8 +368,8 @@ $logo_url::
 $logo_label::
 	URI and label (title) for the Git logo link (or your site logo,
 	if you chose to use different logo image). By default, these both
-	refer to Git homepage, http://git-scm.com[]; in the past, they pointed
-	to Git documentation at http://www.kernel.org[].
+	refer to Git homepage, https://git-scm.com[]; in the past, they pointed
+	to Git documentation at https://www.kernel.org[].
 
 
 Changing gitweb's look
diff --git a/Documentation/howto/rebuild-from-update-hook.txt b/Documentation/howto/rebuild-from-update-hook.txt
index 25378f68d..db219f5c0 100644
--- a/Documentation/howto/rebuild-from-update-hook.txt
+++ b/Documentation/howto/rebuild-from-update-hook.txt
@@ -4,13 +4,13 @@ From: Junio C Hamano <gitster@pobox.com>
 Date: Fri, 26 Aug 2005 18:19:10 -0700
 Abstract: In this how-to article, JC talks about how he
  uses the post-update hook to automate Git documentation page
- shown at http://www.kernel.org/pub/software/scm/git/docs/.
+ shown at https://www.kernel.org/pub/software/scm/git/docs/.
 Content-type: text/asciidoc
 
 How to rebuild from update hook
 ===============================
 
-The pages under http://www.kernel.org/pub/software/scm/git/docs/
+The pages under https://www.kernel.org/pub/software/scm/git/docs/
 are built from Documentation/ directory of the git.git project
 and needed to be kept up-to-date.  The www.kernel.org/ servers
 are mirrored and I was told that the origin of the mirror is on
-- 
2.13.0.rc0.363.g8726c260e


^ permalink raw reply	[flat|threaded] 7+ messages in thread

* [PATCH 2/6] doc: replace or.cz gitwiki link with git.wiki.kernel.org
  2017-04-20 20:32 [PATCH 0/6] fix broken links in Documentation/ Jeff King
  2017-04-20 20:32 ` [PATCH 1/6] doc: use https links to avoid http redirect Jeff King
@ 2017-04-20 20:32 ` Jeff King
  2017-04-20 20:33 ` [PATCH 3/6] gitcore-tutorial: update broken link Jeff King
                   ` (3 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: Jeff King @ 2017-04-20 20:32 UTC (permalink / raw)
  To: git

The or.cz version of the Git wiki went away long ago, and
now just redirects to kernel.org.

Signed-off-by: Jeff King <peff@peff.net>
---
 Documentation/git-tools.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-tools.txt b/Documentation/git-tools.txt
index 2f4ff5015..d0fec4cdd 100644
--- a/Documentation/git-tools.txt
+++ b/Documentation/git-tools.txt
@@ -7,4 +7,4 @@ maintained here. These days, however, search engines fill that role much
 more efficiently, so this manually-maintained list has been retired.
 
 See also the `contrib/` area, and the Git wiki:
-http://git.or.cz/gitwiki/InterfacesFrontendsAndTools
+https://git.wiki.kernel.org/index.php/InterfacesFrontendsAndTools
-- 
2.13.0.rc0.363.g8726c260e


^ permalink raw reply	[flat|threaded] 7+ messages in thread

* [PATCH 3/6] gitcore-tutorial: update broken link
  2017-04-20 20:32 [PATCH 0/6] fix broken links in Documentation/ Jeff King
  2017-04-20 20:32 ` [PATCH 1/6] doc: use https links to avoid http redirect Jeff King
  2017-04-20 20:32 ` [PATCH 2/6] doc: replace or.cz gitwiki link with git.wiki.kernel.org Jeff King
@ 2017-04-20 20:33 ` Jeff King
  2017-04-20 20:34 ` [PATCH 4/6] docs/archimport: quote sourcecontrol.net reference Jeff King
                   ` (2 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: Jeff King @ 2017-04-20 20:33 UTC (permalink / raw)
  To: git

The slides for the Linux-mentoring presentation are no
longer available. Let's point to the wayback version of the
page, which works.

Note that the referenced diagram is also available on page
15 of [1]. We could link to that instead, but it's not clear
from the URL scheme ("uploads") whether it's going to stick
around forever.

[1] https://www.linuxfoundation.jp/jp_uploads/seminar20070313/Randy.pdf

Signed-off-by: Jeff King <peff@peff.net>
---
TBH, I'm not sure this diagram is actually showing anything all that
useful, and maybe the paragraph could be re-worded, or a better diagram
found. I restricted myself here to a technical fix for the broken link,
but I'd be fine with somebody taking a more editorial pass.

 Documentation/gitcore-tutorial.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index 3a0ec8c53..7577f27ec 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -1429,7 +1429,7 @@ Although Git is a truly distributed system, it is often
 convenient to organize your project with an informal hierarchy
 of developers. Linux kernel development is run this way. There
 is a nice illustration (page 17, "Merges to Mainline") in
-http://www.xenotime.net/linux/mentor/linux-mentoring-2006.pdf[Randy Dunlap's presentation].
+https://web.archive.org/web/20120915203609/http://www.xenotime.net/linux/mentor/linux-mentoring-2006.pdf[Randy Dunlap's presentation].
 
 It should be stressed that this hierarchy is purely *informal*.
 There is nothing fundamental in Git that enforces the "chain of
-- 
2.13.0.rc0.363.g8726c260e


^ permalink raw reply	[flat|threaded] 7+ messages in thread

* [PATCH 4/6] docs/archimport: quote sourcecontrol.net reference
  2017-04-20 20:32 [PATCH 0/6] fix broken links in Documentation/ Jeff King
                   ` (2 preceding siblings ...)
  2017-04-20 20:33 ` [PATCH 3/6] gitcore-tutorial: update broken link Jeff King
@ 2017-04-20 20:34 ` Jeff King
  2017-04-20 20:35 ` [PATCH 5/6] docs/bisect-lk2009: update nist report link Jeff King
  2017-04-20 20:35 ` [PATCH 6/6] docs/bisect-lk2009: update java code conventions " Jeff King
  5 siblings, 0 replies; 7+ messages in thread
From: Jeff King @ 2017-04-20 20:34 UTC (permalink / raw)
  To: git

git-archimport has an option to register archives at
mirrors.sourcecontrol.net. The sourcecontrol.net domain
still exists, but that hostname no longer exists.

That means this feature is presumably broken. I'll leave the
examination and modification of that to people who might
actually use archimport. But in the meantime, let's wrap the
reference in the documentation in backticks, which will
avoid turning it into a broken link (and thus polluting
linkchecker results).

Signed-off-by: Jeff King <peff@peff.net>
---
It seems unlikely to me that anybody is using "arch" at all in 2017, so
maybe this whole command could be put to rest. But I didn't want to step
on any toes.

 Documentation/git-archimport.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index 163b9f6f4..ea7065336 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -96,7 +96,7 @@ OPTIONS
 	pruned.
 
 -a::
-	Attempt to auto-register archives at http://mirrors.sourcecontrol.net
+	Attempt to auto-register archives at `http://mirrors.sourcecontrol.net`
 	This is particularly useful with the -D option.
 
 -t <tmpdir>::
-- 
2.13.0.rc0.363.g8726c260e


^ permalink raw reply	[flat|threaded] 7+ messages in thread

* [PATCH 5/6] docs/bisect-lk2009: update nist report link
  2017-04-20 20:32 [PATCH 0/6] fix broken links in Documentation/ Jeff King
                   ` (3 preceding siblings ...)
  2017-04-20 20:34 ` [PATCH 4/6] docs/archimport: quote sourcecontrol.net reference Jeff King
@ 2017-04-20 20:35 ` Jeff King
  2017-04-20 20:35 ` [PATCH 6/6] docs/bisect-lk2009: update java code conventions " Jeff King
  5 siblings, 0 replies; 7+ messages in thread
From: Jeff King @ 2017-04-20 20:35 UTC (permalink / raw)
  To: git

The original NIST press release linked here is no longer
available. But it was just a one-page summary of a larger
planning report; we can link to the report and point people
to the executive summary, which contains the same
information.

Ideally we'd cite it with a DOI, but I couldn't dig one up
for this particular document. I found many URLs pointing to
this report, but they all end up redirecting to this one
(and it looks somewhat official).

Signed-off-by: Jeff King <peff@peff.net>
---
This one and the next are in somewhat of a historical document, so maybe
it's better to leave it as-is. We _do_ build it via "make html", though.

 Documentation/git-bisect-lk2009.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index 716d66d43..263a853fa 100644
--- a/Documentation/git-bisect-lk2009.txt
+++ b/Documentation/git-bisect-lk2009.txt
@@ -1347,7 +1347,7 @@ author to given a talk and for publishing this paper.
 References
 ----------
 
-- [[[1]]] http://www.nist.gov/public_affairs/releases/n02-10.htm['Software Errors Cost U.S. Economy $59.5 Billion Annually'. Nist News Release.]
+- [[[1]]] https://www.nist.gov/sites/default/files/documents/director/planning/report02-3.pdf['The Economic Impacts of Inadequate Infratructure for Software Testing'.  Nist Planning Report 02-3], see Executive Summary and Chapter 8.
 - [[[2]]] http://java.sun.com/docs/codeconv/html/CodeConventions.doc.html#16712['Code Conventions for the Java Programming Language'. Sun Microsystems.]
 - [[[3]]] https://en.wikipedia.org/wiki/Software_maintenance['Software maintenance'. Wikipedia.]
 - [[[4]]] http://article.gmane.org/gmane.comp.version-control.git/45195/[Junio C Hamano. 'Automated bisect success story'. Gmane.]
-- 
2.13.0.rc0.363.g8726c260e


^ permalink raw reply	[flat|threaded] 7+ messages in thread

* [PATCH 6/6] docs/bisect-lk2009: update java code conventions link
  2017-04-20 20:32 [PATCH 0/6] fix broken links in Documentation/ Jeff King
                   ` (4 preceding siblings ...)
  2017-04-20 20:35 ` [PATCH 5/6] docs/bisect-lk2009: update nist report link Jeff King
@ 2017-04-20 20:35 ` " Jeff King
  5 siblings, 0 replies; 7+ messages in thread
From: Jeff King @ 2017-04-20 20:35 UTC (permalink / raw)
  To: git

The old link just redirects to a big index page. I was able
to find a new link for the original document via Google.

Signed-off-by: Jeff King <peff@peff.net>
---
 Documentation/git-bisect-lk2009.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index 263a853fa..8ac75fcc2 100644
--- a/Documentation/git-bisect-lk2009.txt
+++ b/Documentation/git-bisect-lk2009.txt
@@ -1348,7 +1348,7 @@ References
 ----------
 
 - [[[1]]] https://www.nist.gov/sites/default/files/documents/director/planning/report02-3.pdf['The Economic Impacts of Inadequate Infratructure for Software Testing'.  Nist Planning Report 02-3], see Executive Summary and Chapter 8.
-- [[[2]]] http://java.sun.com/docs/codeconv/html/CodeConventions.doc.html#16712['Code Conventions for the Java Programming Language'. Sun Microsystems.]
+- [[[2]]] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html['Code Conventions for the Java Programming Language'. Sun Microsystems.]
 - [[[3]]] https://en.wikipedia.org/wiki/Software_maintenance['Software maintenance'. Wikipedia.]
 - [[[4]]] http://article.gmane.org/gmane.comp.version-control.git/45195/[Junio C Hamano. 'Automated bisect success story'. Gmane.]
 - [[[5]]] https://lwn.net/Articles/317154/[Christian Couder. 'Fully automated bisecting with "git bisect run"'. LWN.net.]
-- 
2.13.0.rc0.363.g8726c260e

^ permalink raw reply	[flat|threaded] 7+ messages in thread

end of thread, back to index

Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-04-20 20:32 [PATCH 0/6] fix broken links in Documentation/ Jeff King
2017-04-20 20:32 ` [PATCH 1/6] doc: use https links to avoid http redirect Jeff King
2017-04-20 20:32 ` [PATCH 2/6] doc: replace or.cz gitwiki link with git.wiki.kernel.org Jeff King
2017-04-20 20:33 ` [PATCH 3/6] gitcore-tutorial: update broken link Jeff King
2017-04-20 20:34 ` [PATCH 4/6] docs/archimport: quote sourcecontrol.net reference Jeff King
2017-04-20 20:35 ` [PATCH 5/6] docs/bisect-lk2009: update nist report link Jeff King
2017-04-20 20:35 ` [PATCH 6/6] docs/bisect-lk2009: update java code conventions " Jeff King

git@vger.kernel.org mailing list mirror (one of many)

Archives are clonable:
	git clone --mirror https://public-inbox.org/git
	git clone --mirror http://ou63pmih66umazou.onion/git
	git clone --mirror http://czquwvybam4bgbro.onion/git
	git clone --mirror http://hjrcffqmbrq6wope.onion/git

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.version-control.git
	nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git
	nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git
	nntp://news.gmane.org/gmane.comp.version-control.git

 note: .onion URLs require Tor: https://www.torproject.org/
       or Tor2web: https://www.tor2web.org/

AGPL code for this site: git clone https://public-inbox.org/ public-inbox