[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [PATCH 1/3] uapi nbd: improve doc links to userspace spec



On Tue, Mar 14, 2023 at 09:23:27AM +0200, Wouter Verhelst wrote:
> Hi Eric,
> 
> On Fri, Mar 10, 2023 at 02:15:23PM -0600, Eric Blake wrote:
> > The documentation file also had a stale link to sourceforge; nbd
> > ditched that several years ago in favor of github.
> 
> While it's accurate to say that we've mostly moved to github, I wouldn't
> describe the sourceforge link as "stale"; I've kept the information on
> that landing page generally up-to-date over the years (the most recent
> change was the addition of the link to Ceph for Windows for a Windows
> NBD client, in 2020), and I do still post file releases on sourceforge,
> primarily.
> 
> However, I guess it's been long enough, and there isn't really anything
> that sourceforge can provide us which github can't, so I suppose we
> might as well.
> 
> Since there is some stuff on that landing page that is currently nowhere
> else, I propose the following patch; comments are welcome. After that,
> I'm happy to move the link from the kernel documentation to github.

So for v2 of the kernel patch, should I split this into two parts -
one to add the spec link in <linux/nbd.h> (that one necessarily to
github.com), the other to tweak the README (where we delay pushing
that one until you are happy that github sufficiently replaces
sf.com)?

> 
> While we're at it, I noticed that the link to nbd.txt in the qemu
> section of doc/proto.md now redirects to gitlab.com, but not to the
> specific file anymore. I've updated that link.
> 
> diff --git a/README.md b/README.md
> index c091406..95df263 100644
> --- a/README.md
> +++ b/README.md
> @@ -21,6 +21,15 @@ If you want to send a patch, please do not open a pull request; instead, send
>  it to the
>  [mailinglist](https://lists.debian.org/nbd)

The README changes to nbd.git look fine to me.

(Always makes me do a double-take to see WHICH readme is being
updated, when we are cross-posting mails to two projects that both use
the file name)

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org


Reply to: