You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Daniel Sahlberg <da...@gmail.com> on 2021/07/04 17:05:07 UTC
JavaHL doc strings
HI,
In a quest that begun in the website replacing http:// with https://, I
ended up in the docstrings in the JavaHL binding.
There are several docstrings like this (for example in CommitInfo.java):
// Update the serialVersionUID when there is a incompatible change made to
// this class. See the java documentation for when a change is
incompatible.
//
http://java.sun.com/javase/7/docs/platform/serialization/spec/version.html#6678
However in some files, for example SubversionException.java, there is a
list of separate links for different Java versions:
// Update the serialVersionUID when there is a incompatible change
// made to this class. See any of the following, depending upon
// the Java release.
//
http://java.sun.com/j2se/1.3/docs/guide/serialization/spec/version.doc7.html
// http://java.sun.com/j2se/1.4/pdf/serial-spec.pdf
//
http://java.sun.com/j2se/1.5.0/docs/guide/serialization/spec/version.html#6678
//
http://java.sun.com/javase/6/docs/platform/serialization/spec/version.html#6678
The basic update is to replace java.sun.com with docs.oracle.com (and some
slight update to the rest of the URL).
- Does it make sense to have the different versions listed or could it be
replaced with just one link?
- Would it make sense to update the links to the latest (or at least latest
LTS) version, or is this just chasing something we can't keep up with in
the end? As far as I can tell, there are no differences between Java 6 up
to Java 14. In Java 16 there are three addditional "compatible changes".
Appreciating any feedback!
Kind regards,
Daniel
Re: JavaHL doc strings
Posted by Daniel Sahlberg <da...@gmail.com>.
Den sön 4 juli 2021 kl 20:23 skrev Nathan Hartman <hartman.nathan@gmail.com
>:
> On Sun, Jul 4, 2021 at 1:05 PM Daniel Sahlberg
> <da...@gmail.com> wrote:
> >
> > HI,
> >
> > In a quest that begun in the website replacing http:// with https://, I
> ended up in the docstrings in the JavaHL binding.
> >
> > There are several docstrings like this (for example in CommitInfo.java):
> > // Update the serialVersionUID when there is a incompatible change made
> to
> > // this class. See the java documentation for when a change is
> incompatible.
> > //
> http://java.sun.com/javase/7/docs/platform/serialization/spec/version.html#6678
> >
> > However in some files, for example SubversionException.java, there is a
> list of separate links for different Java versions:
> > // Update the serialVersionUID when there is a incompatible change
> > // made to this class. See any of the following, depending upon
> > // the Java release.
> > //
> http://java.sun.com/j2se/1.3/docs/guide/serialization/spec/version.doc7.html
> > // http://java.sun.com/j2se/1.4/pdf/serial-spec.pdf
> > //
> http://java.sun.com/j2se/1.5.0/docs/guide/serialization/spec/version.html#6678
> > //
> http://java.sun.com/javase/6/docs/platform/serialization/spec/version.html#6678
> >
> > The basic update is to replace java.sun.com with docs.oracle.com (and
> some slight update to the rest of the URL).
> >
> > - Does it make sense to have the different versions listed or could it
> be replaced with just one link?
> >
> > - Would it make sense to update the links to the latest (or at least
> latest LTS) version, or is this just chasing something we can't keep up
> with in the end? As far as I can tell, there are no differences between
> Java 6 up to Java 14. In Java 16 there are three addditional "compatible
> changes".
>
>
> My opinion is, just put the latest LTS link; it will be an improvement
> to update those sun.com links which seem to be about a decade
> out-of-date; if you feel it's appropriate, you could change the note
> to read "See the following, or its counterpart in your specific Java
> release" or something like that. I think that's better than giving a
> long list of links to all different versions of the same doc.
>
I agree this is the solution that makes the most sense. I'll commit it
shortly.
Also I noticed a little grammar typo in the comments above the links:
> "a incompatible change" should be "an incompatible change" (s/a/an/).
>
Oh. I'll change it while I'm at it.
Thanks for reviewing!
Kind regards,
Daniel Sahlberg
Re: JavaHL doc strings
Posted by Nathan Hartman <ha...@gmail.com>.
On Sun, Jul 4, 2021 at 1:05 PM Daniel Sahlberg
<da...@gmail.com> wrote:
>
> HI,
>
> In a quest that begun in the website replacing http:// with https://, I ended up in the docstrings in the JavaHL binding.
>
> There are several docstrings like this (for example in CommitInfo.java):
> // Update the serialVersionUID when there is a incompatible change made to
> // this class. See the java documentation for when a change is incompatible.
> // http://java.sun.com/javase/7/docs/platform/serialization/spec/version.html#6678
>
> However in some files, for example SubversionException.java, there is a list of separate links for different Java versions:
> // Update the serialVersionUID when there is a incompatible change
> // made to this class. See any of the following, depending upon
> // the Java release.
> // http://java.sun.com/j2se/1.3/docs/guide/serialization/spec/version.doc7.html
> // http://java.sun.com/j2se/1.4/pdf/serial-spec.pdf
> // http://java.sun.com/j2se/1.5.0/docs/guide/serialization/spec/version.html#6678
> // http://java.sun.com/javase/6/docs/platform/serialization/spec/version.html#6678
>
> The basic update is to replace java.sun.com with docs.oracle.com (and some slight update to the rest of the URL).
>
> - Does it make sense to have the different versions listed or could it be replaced with just one link?
>
> - Would it make sense to update the links to the latest (or at least latest LTS) version, or is this just chasing something we can't keep up with in the end? As far as I can tell, there are no differences between Java 6 up to Java 14. In Java 16 there are three addditional "compatible changes".
My opinion is, just put the latest LTS link; it will be an improvement
to update those sun.com links which seem to be about a decade
out-of-date; if you feel it's appropriate, you could change the note
to read "See the following, or its counterpart in your specific Java
release" or something like that. I think that's better than giving a
long list of links to all different versions of the same doc.
Also I noticed a little grammar typo in the comments above the links:
"a incompatible change" should be "an incompatible change" (s/a/an/).
Thanks!
Nathan