diff mbox series

[v2,2/2] git-bisect-lk2009: update nist report link

Message ID 20230110093251.193552-3-rybak.a.v@gmail.com (mailing list archive)
State Accepted
Commit f5156f18858aab652a40e008611db83efe4023fe
Headers show
Series update references in git-bisect-lk2009.txt | expand

Commit Message

Andrei Rybak Jan. 10, 2023, 9:32 a.m. UTC
Commit d656218a83 (docs/bisect-lk2009: update nist report link,
2017-04-20) replaced a dead link to news release on nist.gov.  However,
this might be confusing to the reader (like myself) because the article
git-bisect-lk2009.txt quotes from the news release but the exact quote
cannot be found in the full report.  In addition to that, the link added
in 2017 is also dead in 2023.

Replace the reference to nist.gov with an version of the original NIST
news release archived to the Wayback Machine.  Include also an updated
link to a live version of the full report.

Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
---
 Documentation/git-bisect-lk2009.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

I wasn't sure about inclusion of links to https://web.archive.org, but there is
a single precedent already in "Documentation/gitcore-tutorial.txt".

Comments

Jeff King Jan. 10, 2023, 12:26 p.m. UTC | #1
On Tue, Jan 10, 2023 at 10:32:51AM +0100, Andrei Rybak wrote:

> Commit d656218a83 (docs/bisect-lk2009: update nist report link,
> 2017-04-20) replaced a dead link to news release on nist.gov.  However,
> this might be confusing to the reader (like myself) because the article
> git-bisect-lk2009.txt quotes from the news release but the exact quote
> cannot be found in the full report.  In addition to that, the link added
> in 2017 is also dead in 2023.
> 
> Replace the reference to nist.gov with an version of the original NIST
> news release archived to the Wayback Machine.  Include also an updated
> link to a live version of the full report.

Both this and the other patch seem reasonable to me.

> I wasn't sure about inclusion of links to https://web.archive.org, but there is
> a single precedent already in "Documentation/gitcore-tutorial.txt".

I think it's a good match for this kind of link. The point is to cite a
historical artifact, and if archive.org is the only way to get the artifact,
then that's what we should do. Arguably it's what I should have done in
d656218a83 in the first place.

> --- 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]]] 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.
> +- [[[1]]] https://web.archive.org/web/20091206032101/http://www.nist.gov/public_affairs/releases/n02-10.htm['Software Errors Cost U.S. Economy $59.5 Billion Annually'. Nist News Release.] See also https://www.nist.gov/system/files/documents/director/planning/report02-3.pdf['The Economic Impacts of Inadequate Infratructure for Software Testing'.  Nist Planning Report 02-3], Executive Summary and Chapter 8.

The link target given to archive.org is for http, not https. I guess it
doesn't really matter as they archived the same content back then, and
the actual browser connection to archive.org will be over https. And
yours is more historically accurate. ;)

-Peff
diff mbox series

Patch

diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index 36168792ee..0bc165788e 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]]] 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.
+- [[[1]]] https://web.archive.org/web/20091206032101/http://www.nist.gov/public_affairs/releases/n02-10.htm['Software Errors Cost U.S. Economy $59.5 Billion Annually'. Nist News Release.] See also https://www.nist.gov/system/files/documents/director/planning/report02-3.pdf['The Economic Impacts of Inadequate Infratructure for Software Testing'.  Nist Planning Report 02-3], Executive Summary and Chapter 8.
 - [[[2]]] https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html['Code Conventions for the Java Programming Language: 1. Introduction'. Sun Microsystems.]
 - [[[3]]] https://en.wikipedia.org/wiki/Software_maintenance['Software maintenance'. Wikipedia.]
 - [[[4]]] https://lore.kernel.org/git/7vps5xsbwp.fsf_-_@assigned-by-dhcp.cox.net/[Junio C Hamano. 'Automated bisect success story'.]