Linux-Doc Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] docs: fix the invalid vt-d spec location
@ 2021-04-18 16:29 Liang Zhou
  2021-04-18 16:59 ` Borislav Petkov
  0 siblings, 1 reply; 4+ messages in thread
From: Liang Zhou @ 2021-04-18 16:29 UTC (permalink / raw)
  To: tglx, mingo, bp, x86, hpa, corbet; +Cc: linux-kernel, linux-doc, zhoul110

This patch fixes the invalid vt-d spec location.

Signed-off-by: Liang Zhou <zhoul110@chinatelecom.cn>
---
 Documentation/x86/intel-iommu.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/x86/intel-iommu.rst b/Documentation/x86/intel-iommu.rst
index 099f13d..e95ee34 100644
--- a/Documentation/x86/intel-iommu.rst
+++ b/Documentation/x86/intel-iommu.rst
@@ -4,7 +4,7 @@ Linux IOMMU Support
 
 The architecture spec can be obtained from the below location.
 
-http://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/vt-directed-io-spec.pdf
+https://software.intel.com/content/dam/develop/external/us/en/documents-tps/vt-directed-io-spec.pdf
 
 This guide gives a quick cheat sheet for some basic understanding.
 
-- 
1.8.3.1


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] docs: fix the invalid vt-d spec location
  2021-04-18 16:29 [PATCH] docs: fix the invalid vt-d spec location Liang Zhou
@ 2021-04-18 16:59 ` Borislav Petkov
  2021-04-19  8:05   ` Steven Zhou
  0 siblings, 1 reply; 4+ messages in thread
From: Borislav Petkov @ 2021-04-18 16:59 UTC (permalink / raw)
  To: Liang Zhou
  Cc: tglx, mingo, x86, hpa, corbet, linux-kernel, linux-doc, zhoul110

On Sun, Apr 18, 2021 at 09:29:46AM -0700, Liang Zhou wrote:
> This patch fixes the invalid vt-d spec location.

Avoid having "This patch" or "This commit" in the commit message. It is
tautologically useless.

Also, do

$ git grep 'This patch' Documentation/process

for more details.

> Signed-off-by: Liang Zhou <zhoul110@chinatelecom.cn>
> ---
>  Documentation/x86/intel-iommu.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/x86/intel-iommu.rst b/Documentation/x86/intel-iommu.rst
> index 099f13d..e95ee34 100644
> --- a/Documentation/x86/intel-iommu.rst
> +++ b/Documentation/x86/intel-iommu.rst
> @@ -4,7 +4,7 @@ Linux IOMMU Support
>  
>  The architecture spec can be obtained from the below location.
>  
> -http://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/vt-directed-io-spec.pdf
> +https://software.intel.com/content/dam/develop/external/us/en/documents-tps/vt-directed-io-spec.pdf

Those links are never stable.

Please open a bugzilla at bugzilla.kernel.org, upload that document
there, like this, for example:

https://bugzilla.kernel.org/show_bug.cgi?id=206537

and then add the *bugzilla* link to intel-iommu.rst so that it doesn't
get invalid again.

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] docs: fix the invalid vt-d spec location
  2021-04-18 16:59 ` Borislav Petkov
@ 2021-04-19  8:05   ` Steven Zhou
  2021-04-20 18:58     ` Borislav Petkov
  0 siblings, 1 reply; 4+ messages in thread
From: Steven Zhou @ 2021-04-19  8:05 UTC (permalink / raw)
  To: Borislav Petkov
  Cc: tglx, mingo, x86, hpa, corbet, linux-kernel, linux-doc, Liang Zhou

Hi Boris,

Thank you for your comments.

The vt-d spec PDF is around 11M size and after be zipped it's still
around 10M size which cannot be uploaded to "bugzilla.kernel.org"
because this site limits 5M file size to be uploaded.
Seems currently I cannot use the similar way as what you suggested to
specify the bugzilla attachment link in intel-iommu.rst .

Do you have any other suggestion about the link location please ?

Thanks.

On Mon, Apr 19, 2021 at 12:59 AM Borislav Petkov <bp@alien8.de> wrote:
>
> On Sun, Apr 18, 2021 at 09:29:46AM -0700, Liang Zhou wrote:
> > This patch fixes the invalid vt-d spec location.
>
> Avoid having "This patch" or "This commit" in the commit message. It is
> tautologically useless.
>
> Also, do
>
> $ git grep 'This patch' Documentation/process
>
> for more details.
>
> > Signed-off-by: Liang Zhou <zhoul110@chinatelecom.cn>
> > ---
> >  Documentation/x86/intel-iommu.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/x86/intel-iommu.rst b/Documentation/x86/intel-iommu.rst
> > index 099f13d..e95ee34 100644
> > --- a/Documentation/x86/intel-iommu.rst
> > +++ b/Documentation/x86/intel-iommu.rst
> > @@ -4,7 +4,7 @@ Linux IOMMU Support
> >
> >  The architecture spec can be obtained from the below location.
> >
> > -http://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/vt-directed-io-spec.pdf
> > +https://software.intel.com/content/dam/develop/external/us/en/documents-tps/vt-directed-io-spec.pdf
>
> Those links are never stable.
>
> Please open a bugzilla at bugzilla.kernel.org, upload that document
> there, like this, for example:
>
> https://bugzilla.kernel.org/show_bug.cgi?id=206537
>
> and then add the *bugzilla* link to intel-iommu.rst so that it doesn't
> get invalid again.
>
> Thx.
>
> --
> Regards/Gruss,
>     Boris.
>
> https://people.kernel.org/tglx/notes-about-netiquette



-- 
Best Regards.
Liang

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] docs: fix the invalid vt-d spec location
  2021-04-19  8:05   ` Steven Zhou
@ 2021-04-20 18:58     ` Borislav Petkov
  0 siblings, 0 replies; 4+ messages in thread
From: Borislav Petkov @ 2021-04-20 18:58 UTC (permalink / raw)
  To: Steven Zhou
  Cc: tglx, mingo, x86, hpa, corbet, linux-kernel, linux-doc, Liang Zhou

On Mon, Apr 19, 2021 at 04:05:12PM +0800, Steven Zhou wrote:
> Do you have any other suggestion about the link location please ?

Yeah, I'm working on it. We need to come up with a proper solution for
all those docs but it'll take time...

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, back to index

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-18 16:29 [PATCH] docs: fix the invalid vt-d spec location Liang Zhou
2021-04-18 16:59 ` Borislav Petkov
2021-04-19  8:05   ` Steven Zhou
2021-04-20 18:58     ` Borislav Petkov

Linux-Doc Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-doc/0 linux-doc/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-doc linux-doc/ https://lore.kernel.org/linux-doc \
		linux-doc@vger.kernel.org
	public-inbox-index linux-doc

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-doc


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