rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/2] docs: rust: update Rust docs output path
@ 2023-10-18 16:01 ` Miguel Ojeda
  2023-10-18 16:01   ` [PATCH 2/2] kbuild: remove old " Miguel Ojeda
                     ` (5 more replies)
  0 siblings, 6 replies; 11+ messages in thread
From: Miguel Ojeda @ 2023-10-18 16:01 UTC (permalink / raw)
  To: Masahiro Yamada, Jonathan Corbet, Carlos Bilbao, Miguel Ojeda,
	Wedson Almeida Filho, Alex Gaynor
  Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
	Andreas Hindborg, Alice Ryhl, linux-kbuild, linux-doc,
	rust-for-linux, linux-kernel, patches, Akira Yokosawa,
	Martin Rodriguez Reboredo

The Rust code documentation output path moved from `rust/doc` to
`Documentation/output/rust/rustdoc`, thus update the old reference.

Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 Documentation/rust/general-information.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/rust/general-information.rst b/Documentation/rust/general-information.rst
index 49029ee82e55..081397827a7e 100644
--- a/Documentation/rust/general-information.rst
+++ b/Documentation/rust/general-information.rst
@@ -29,7 +29,7 @@ target with the same invocation used for compilation, e.g.::
 
 To read the docs locally in your web browser, run e.g.::
 
-	xdg-open rust/doc/kernel/index.html
+	xdg-open Documentation/output/rust/rustdoc/kernel/index.html
 
 To learn about how to write the documentation, please see coding-guidelines.rst.
 

base-commit: 8a749fd1a8720d4619c91c8b6e7528c0a355c0aa
-- 
2.42.0


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

* [PATCH 2/2] kbuild: remove old Rust docs output path
  2023-10-18 16:01 ` [PATCH 1/2] docs: rust: update Rust docs output path Miguel Ojeda
@ 2023-10-18 16:01   ` Miguel Ojeda
  2023-10-18 17:56     ` Benno Lossin
                       ` (3 more replies)
  2023-10-18 17:55   ` [PATCH 1/2] docs: rust: update " Benno Lossin
                     ` (4 subsequent siblings)
  5 siblings, 4 replies; 11+ messages in thread
From: Miguel Ojeda @ 2023-10-18 16:01 UTC (permalink / raw)
  To: Masahiro Yamada, Jonathan Corbet, Carlos Bilbao, Miguel Ojeda,
	Wedson Almeida Filho, Alex Gaynor
  Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
	Andreas Hindborg, Alice Ryhl, linux-kbuild, linux-doc,
	rust-for-linux, linux-kernel, patches, Nathan Chancellor,
	Nick Desaulniers, Nicolas Schier, Martin Rodriguez Reboredo,
	Akira Yokosawa

The Rust code documentation output path moved from `rust/doc` to
`Documentation/output/rust/rustdoc`. The `make cleandocs` target
takes care of cleaning it now since it is integrated with the rest
of the documentation.

Thus remove the old reference.

Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index 373649c7374e..040018111f32 100644
--- a/Makefile
+++ b/Makefile
@@ -1474,7 +1474,7 @@ endif # CONFIG_MODULES
 # Directories & files removed with 'make clean'
 CLEAN_FILES += vmlinux.symvers modules-only.symvers \
 	       modules.builtin modules.builtin.modinfo modules.nsdeps \
-	       compile_commands.json .thinlto-cache rust/test rust/doc \
+	       compile_commands.json .thinlto-cache rust/test \
 	       rust-project.json .vmlinux.objs .vmlinux.export.c
 
 # Directories & files removed with 'make mrproper'
-- 
2.42.0


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

* Re: [PATCH 1/2] docs: rust: update Rust docs output path
  2023-10-18 16:01 ` [PATCH 1/2] docs: rust: update Rust docs output path Miguel Ojeda
  2023-10-18 16:01   ` [PATCH 2/2] kbuild: remove old " Miguel Ojeda
@ 2023-10-18 17:55   ` Benno Lossin
  2023-10-18 21:50   ` Alice Ryhl
                     ` (3 subsequent siblings)
  5 siblings, 0 replies; 11+ messages in thread
From: Benno Lossin @ 2023-10-18 17:55 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: Masahiro Yamada, Jonathan Corbet, Carlos Bilbao,
	Wedson Almeida Filho, Alex Gaynor, Boqun Feng, Gary Guo,
	Björn Roy Baron, Andreas Hindborg, Alice Ryhl, linux-kbuild,
	linux-doc, rust-for-linux, linux-kernel, patches, Akira Yokosawa,
	Martin Rodriguez Reboredo

On 18.10.23 18:01, Miguel Ojeda wrote:
> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`, thus update the old reference.
> 
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Benno Lossin <benno.lossin@proton.me>

-- 
Cheers,
Benno

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

* Re: [PATCH 2/2] kbuild: remove old Rust docs output path
  2023-10-18 16:01   ` [PATCH 2/2] kbuild: remove old " Miguel Ojeda
@ 2023-10-18 17:56     ` Benno Lossin
  2023-10-18 21:51     ` Alice Ryhl
                       ` (2 subsequent siblings)
  3 siblings, 0 replies; 11+ messages in thread
From: Benno Lossin @ 2023-10-18 17:56 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: Masahiro Yamada, Jonathan Corbet, Carlos Bilbao,
	Wedson Almeida Filho, Alex Gaynor, Boqun Feng, Gary Guo,
	Björn Roy Baron, Andreas Hindborg, Alice Ryhl, linux-kbuild,
	linux-doc, rust-for-linux, linux-kernel, patches,
	Nathan Chancellor, Nick Desaulniers, Nicolas Schier,
	Martin Rodriguez Reboredo, Akira Yokosawa

On 18.10.23 18:01, Miguel Ojeda wrote:
> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`. The `make cleandocs` target
> takes care of cleaning it now since it is integrated with the rest
> of the documentation.
> 
> Thus remove the old reference.
> 
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Benno Lossin <benno.lossin@proton.me>

-- 
Cheers,
Benno

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

* Re: [PATCH 1/2] docs: rust: update Rust docs output path
  2023-10-18 16:01 ` [PATCH 1/2] docs: rust: update Rust docs output path Miguel Ojeda
  2023-10-18 16:01   ` [PATCH 2/2] kbuild: remove old " Miguel Ojeda
  2023-10-18 17:55   ` [PATCH 1/2] docs: rust: update " Benno Lossin
@ 2023-10-18 21:50   ` Alice Ryhl
  2023-10-18 22:57   ` Miguel Ojeda
                     ` (2 subsequent siblings)
  5 siblings, 0 replies; 11+ messages in thread
From: Alice Ryhl @ 2023-10-18 21:50 UTC (permalink / raw)
  To: Miguel Ojeda, Masahiro Yamada, Jonathan Corbet, Carlos Bilbao,
	Wedson Almeida Filho, Alex Gaynor
  Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
	Andreas Hindborg, Alice Ryhl, linux-kbuild, linux-doc,
	rust-for-linux, linux-kernel, patches, Akira Yokosawa,
	Martin Rodriguez Reboredo

On 10/18/23 18:01, Miguel Ojeda wrote:
> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`, thus update the old reference.
> 
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

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

* Re: [PATCH 2/2] kbuild: remove old Rust docs output path
  2023-10-18 16:01   ` [PATCH 2/2] kbuild: remove old " Miguel Ojeda
  2023-10-18 17:56     ` Benno Lossin
@ 2023-10-18 21:51     ` Alice Ryhl
  2023-10-19 12:03     ` Andreas Hindborg
  2023-10-23 14:43     ` Carlos Bilbao
  3 siblings, 0 replies; 11+ messages in thread
From: Alice Ryhl @ 2023-10-18 21:51 UTC (permalink / raw)
  To: Miguel Ojeda, Masahiro Yamada, Jonathan Corbet, Carlos Bilbao,
	Wedson Almeida Filho, Alex Gaynor
  Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
	Andreas Hindborg, Alice Ryhl, linux-kbuild, linux-doc,
	rust-for-linux, linux-kernel, patches, Nathan Chancellor,
	Nick Desaulniers, Nicolas Schier, Martin Rodriguez Reboredo,
	Akira Yokosawa

On 10/18/23 18:01, Miguel Ojeda wrote:
> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`. The `make cleandocs` target
> takes care of cleaning it now since it is integrated with the rest
> of the documentation.
> 
> Thus remove the old reference.
> 
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

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

* Re: [PATCH 1/2] docs: rust: update Rust docs output path
  2023-10-18 16:01 ` [PATCH 1/2] docs: rust: update Rust docs output path Miguel Ojeda
                     ` (2 preceding siblings ...)
  2023-10-18 21:50   ` Alice Ryhl
@ 2023-10-18 22:57   ` Miguel Ojeda
  2023-10-19 12:03   ` Andreas Hindborg
  2023-10-23 14:43   ` Carlos Bilbao
  5 siblings, 0 replies; 11+ messages in thread
From: Miguel Ojeda @ 2023-10-18 22:57 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: Masahiro Yamada, Jonathan Corbet, Carlos Bilbao,
	Wedson Almeida Filho, Alex Gaynor, Boqun Feng, Gary Guo,
	Björn Roy Baron, Benno Lossin, Andreas Hindborg, Alice Ryhl,
	linux-kbuild, linux-doc, rust-for-linux, linux-kernel, patches,
	Akira Yokosawa, Martin Rodriguez Reboredo

On Wed, Oct 18, 2023 at 6:02 PM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`, thus update the old reference.
>
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Applied to `rust-fixes` early to start getting some time in
`linux-next` -- please feel free to send more reviews, thanks!

Cheers,
Miguel

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

* Re: [PATCH 1/2] docs: rust: update Rust docs output path
  2023-10-18 16:01 ` [PATCH 1/2] docs: rust: update Rust docs output path Miguel Ojeda
                     ` (3 preceding siblings ...)
  2023-10-18 22:57   ` Miguel Ojeda
@ 2023-10-19 12:03   ` Andreas Hindborg
  2023-10-23 14:43   ` Carlos Bilbao
  5 siblings, 0 replies; 11+ messages in thread
From: Andreas Hindborg @ 2023-10-19 12:03 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: Masahiro Yamada, Jonathan Corbet, Carlos Bilbao,
	Wedson Almeida Filho, Alex Gaynor, Boqun Feng, Gary Guo,
	Björn Roy Baron, Benno Lossin, Alice Ryhl,
	linux-kbuild@vger.kernel.org, linux-doc@vger.kernel.org,
	rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
	patches@lists.linux.dev, Akira Yokosawa,
	Martin Rodriguez Reboredo


Miguel Ojeda <ojeda@kernel.org> writes:

> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`, thus update the old reference.
>
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Andreas Hindborg <a.hindborg@samsung.com>

> ---
>  Documentation/rust/general-information.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/rust/general-information.rst b/Documentation/rust/general-information.rst
> index 49029ee82e55..081397827a7e 100644
> --- a/Documentation/rust/general-information.rst
> +++ b/Documentation/rust/general-information.rst
> @@ -29,7 +29,7 @@ target with the same invocation used for compilation, e.g.::
>  
>  To read the docs locally in your web browser, run e.g.::
>  
> -	xdg-open rust/doc/kernel/index.html
> +	xdg-open Documentation/output/rust/rustdoc/kernel/index.html
>  
>  To learn about how to write the documentation, please see coding-guidelines.rst.
>  
>
> base-commit: 8a749fd1a8720d4619c91c8b6e7528c0a355c0aa

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

* Re: [PATCH 2/2] kbuild: remove old Rust docs output path
  2023-10-18 16:01   ` [PATCH 2/2] kbuild: remove old " Miguel Ojeda
  2023-10-18 17:56     ` Benno Lossin
  2023-10-18 21:51     ` Alice Ryhl
@ 2023-10-19 12:03     ` Andreas Hindborg
  2023-10-23 14:43     ` Carlos Bilbao
  3 siblings, 0 replies; 11+ messages in thread
From: Andreas Hindborg @ 2023-10-19 12:03 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: Masahiro Yamada, Jonathan Corbet, Carlos Bilbao,
	Wedson Almeida Filho, Alex Gaynor, Boqun Feng, Gary Guo,
	Björn Roy Baron, Benno Lossin, Alice Ryhl,
	linux-kbuild@vger.kernel.org, linux-doc@vger.kernel.org,
	rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
	patches@lists.linux.dev, Nathan Chancellor, Nick Desaulniers,
	Nicolas Schier, Martin Rodriguez Reboredo, Akira Yokosawa


Miguel Ojeda <ojeda@kernel.org> writes:

> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`. The `make cleandocs` target
> takes care of cleaning it now since it is integrated with the rest
> of the documentation.
>
> Thus remove the old reference.
>
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
>

Reviewed-by: Andreas Hindborg <a.hindborg@samsung.com>

 ---
>  Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 373649c7374e..040018111f32 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1474,7 +1474,7 @@ endif # CONFIG_MODULES
>  # Directories & files removed with 'make clean'
>  CLEAN_FILES += vmlinux.symvers modules-only.symvers \
>  	       modules.builtin modules.builtin.modinfo modules.nsdeps \
> -	       compile_commands.json .thinlto-cache rust/test rust/doc \
> +	       compile_commands.json .thinlto-cache rust/test \
>  	       rust-project.json .vmlinux.objs .vmlinux.export.c
>  
>  # Directories & files removed with 'make mrproper'

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

* Re: [PATCH 2/2] kbuild: remove old Rust docs output path
  2023-10-18 16:01   ` [PATCH 2/2] kbuild: remove old " Miguel Ojeda
                       ` (2 preceding siblings ...)
  2023-10-19 12:03     ` Andreas Hindborg
@ 2023-10-23 14:43     ` Carlos Bilbao
  3 siblings, 0 replies; 11+ messages in thread
From: Carlos Bilbao @ 2023-10-23 14:43 UTC (permalink / raw)
  To: Miguel Ojeda, Masahiro Yamada, Jonathan Corbet,
	Wedson Almeida Filho, Alex Gaynor
  Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
	Andreas Hindborg, Alice Ryhl, linux-kbuild, linux-doc,
	rust-for-linux, linux-kernel, patches, Nathan Chancellor,
	Nick Desaulniers, Nicolas Schier, Martin Rodriguez Reboredo,
	Akira Yokosawa

On 10/18/23 11:01, Miguel Ojeda wrote:
> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`. The `make cleandocs` target
> takes care of cleaning it now since it is integrated with the rest
> of the documentation.
> 
> Thus remove the old reference.
> 
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
>   Makefile | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Makefile b/Makefile
> index 373649c7374e..040018111f32 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1474,7 +1474,7 @@ endif # CONFIG_MODULES
>   # Directories & files removed with 'make clean'
>   CLEAN_FILES += vmlinux.symvers modules-only.symvers \
>   	       modules.builtin modules.builtin.modinfo modules.nsdeps \
> -	       compile_commands.json .thinlto-cache rust/test rust/doc \
> +	       compile_commands.json .thinlto-cache rust/test \
>   	       rust-project.json .vmlinux.objs .vmlinux.export.c
>   
>   # Directories & files removed with 'make mrproper'

Reviewed-by: Carlos Bilbao <carlos.bilbao@amd.com>

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

* Re: [PATCH 1/2] docs: rust: update Rust docs output path
  2023-10-18 16:01 ` [PATCH 1/2] docs: rust: update Rust docs output path Miguel Ojeda
                     ` (4 preceding siblings ...)
  2023-10-19 12:03   ` Andreas Hindborg
@ 2023-10-23 14:43   ` Carlos Bilbao
  5 siblings, 0 replies; 11+ messages in thread
From: Carlos Bilbao @ 2023-10-23 14:43 UTC (permalink / raw)
  To: Miguel Ojeda, Masahiro Yamada, Jonathan Corbet,
	Wedson Almeida Filho, Alex Gaynor
  Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
	Andreas Hindborg, Alice Ryhl, linux-kbuild, linux-doc,
	rust-for-linux, linux-kernel, patches, Akira Yokosawa,
	Martin Rodriguez Reboredo

On 10/18/23 11:01, Miguel Ojeda wrote:
> The Rust code documentation output path moved from `rust/doc` to
> `Documentation/output/rust/rustdoc`, thus update the old reference.
> 
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
>   Documentation/rust/general-information.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/rust/general-information.rst b/Documentation/rust/general-information.rst
> index 49029ee82e55..081397827a7e 100644
> --- a/Documentation/rust/general-information.rst
> +++ b/Documentation/rust/general-information.rst
> @@ -29,7 +29,7 @@ target with the same invocation used for compilation, e.g.::
>   
>   To read the docs locally in your web browser, run e.g.::
>   
> -	xdg-open rust/doc/kernel/index.html
> +	xdg-open Documentation/output/rust/rustdoc/kernel/index.html
>   
>   To learn about how to write the documentation, please see coding-guidelines.rst.
>   
> 
> base-commit: 8a749fd1a8720d4619c91c8b6e7528c0a355c0aa

Good catch!

Reviewed-by: Carlos Bilbao <carlos.bilbao@amd.com>

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

end of thread, other threads:[~2023-10-23 14:43 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
     [not found] <CGME20231018160207eucas1p1db839e2eb9a2ad39013c08c0e6f4624e@eucas1p1.samsung.com>
2023-10-18 16:01 ` [PATCH 1/2] docs: rust: update Rust docs output path Miguel Ojeda
2023-10-18 16:01   ` [PATCH 2/2] kbuild: remove old " Miguel Ojeda
2023-10-18 17:56     ` Benno Lossin
2023-10-18 21:51     ` Alice Ryhl
2023-10-19 12:03     ` Andreas Hindborg
2023-10-23 14:43     ` Carlos Bilbao
2023-10-18 17:55   ` [PATCH 1/2] docs: rust: update " Benno Lossin
2023-10-18 21:50   ` Alice Ryhl
2023-10-18 22:57   ` Miguel Ojeda
2023-10-19 12:03   ` Andreas Hindborg
2023-10-23 14:43   ` Carlos Bilbao

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).