threads / patch / 59063

patchgit-bisect-lk2009: update java code conventions link

Subject: [PATCH] git-bisect-lk2009: update java code conventions link

## tl;dr

5 messages between Jan 10, 2023 and Jan 10, 2023. Diffs are folded; open one to read it.

replies: 4people: 2as markdown or json

Andrei Rybak· Jan 10, 2023, 08:38 UTC · lore

A reference to Java Code Conventions in git-bisect-lk2009.txt uses an outdated URL that redirects to table of contents for the conventions. The actual claim about "80%" that this reference backs up is on the first page of the conventions:

  https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html

Use this newer URL and its title in the reference.

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

Show changes to Documentation/git-bisect-lk2009.txt +1 −1

diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index f3d9566c89..36168792ee 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://www.oracle.com/technetwork/java/codeconvtoc-136057.html['Code Conventions for the Java Programming Language'. Sun Microsystems.]
+- [[[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'.]
 - [[[5]]] https://lwn.net/Articles/317154/[Christian Couder. 'Fully automated bisecting with "git bisect run"'. LWN.net.]

-- 
2.38.1

Andrei Rybak· Jan 10, 2023, 09:32 UTC · re: Andrei Rybak · lore

[PATCH v2 0/2] update references in git-bisect-lk2009.txt

While double-checking the patch I noticed that nist.gov link is also dead.

Changes since v1:

 * new second patch which fixes nist report link

Andrei Rybak (2):
  git-bisect-lk2009: update java code conventions link
  git-bisect-lk2009: update nist report link

 Documentation/git-bisect-lk2009.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.38.1

Andrei Rybak· Jan 10, 2023, 09:32 UTC · re: Andrei Rybak · lore

[PATCH v2 1/2] git-bisect-lk2009: update java code conventions link

  https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html

Use this newer URL and its title in the reference.

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

Show changes to Documentation/git-bisect-lk2009.txt +1 −1

diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index f3d9566c89..36168792ee 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://www.oracle.com/technetwork/java/codeconvtoc-136057.html['Code Conventions for the Java Programming Language'. Sun Microsystems.]
+- [[[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'.]
 - [[[5]]] https://lwn.net/Articles/317154/[Christian Couder. 'Fully automated bisecting with "git bisect run"'. LWN.net.]

-- 
2.38.1

Andrei Rybak· Jan 10, 2023, 09:32 UTC · re: Andrei Rybak · lore

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

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

Show changes to Documentation/git-bisect-lk2009.txt +1 −1

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'.]

-- 
2.38.1

Jeff King· Jan 10, 2023, 12:26 UTC · re: Andrei Rybak · lore

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

On Tue, Jan 10, 2023 at 10:32:51AM +0100, Andrei Rybak wrote:

Show 10 quoted lines

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

Show 8 quoted lines

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