2023-10-18 16:02:09

by Miguel Ojeda

Subject: [PATCH 1/2] docs: rust: update Rust docs output path

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 <[email protected]>
---
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

2023-10-18 16:02:23

by Miguel Ojeda

Subject: [PATCH 2/2] kbuild: remove old Rust docs output path

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 <[email protected]>
---
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

2023-10-18 17:56:45

by Benno Lossin

Subject: Re: [PATCH 1/2] docs: rust: update Rust docs output path

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 <[email protected]>

Reviewed-by: Benno Lossin <[email protected]>

--
Cheers,
Benno

2023-10-18 17:57:53

by Benno Lossin

Subject: Re: [PATCH 2/2] kbuild: remove old Rust docs output path

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 <[email protected]>

Reviewed-by: Benno Lossin <[email protected]>

--
Cheers,
Benno

2023-10-18 21:51:26

by Alice Ryhl

Subject: Re: [PATCH 1/2] docs: rust: update Rust docs output path

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 <[email protected]>

Reviewed-by: Alice Ryhl <[email protected]>

2023-10-18 21:51:31

by Alice Ryhl

Subject: Re: [PATCH 2/2] kbuild: remove old Rust docs output path

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 <[email protected]>

Reviewed-by: Alice Ryhl <[email protected]>

2023-10-18 22:57:45

by Miguel Ojeda

Subject: Re: [PATCH 1/2] docs: rust: update Rust docs output path

On Wed, Oct 18, 2023 at 6:02 PM Miguel Ojeda <[email protected]> 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 <[email protected]>

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

Cheers,
Miguel

2023-10-19 12:04:44

by Andreas Hindborg

Subject: Re: [PATCH 1/2] docs: rust: update Rust docs output path

Miguel Ojeda <[email protected]> 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 <[email protected]>

Reviewed-by: Andreas Hindborg <[email protected]>

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

2023-10-19 12:07:18

by Andreas Hindborg

Subject: Re: [PATCH 2/2] kbuild: remove old Rust docs output path

Miguel Ojeda <[email protected]> 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 <[email protected]>
>

Reviewed-by: Andreas Hindborg <[email protected]>

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

2023-10-23 14:46:14

by Bilbao, Carlos

Subject: Re: [PATCH 1/2] docs: rust: update Rust docs output path

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 <[email protected]>
> ---
> 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 <[email protected]>

2023-10-23 14:58:38

by Bilbao, Carlos

Subject: Re: [PATCH 2/2] kbuild: remove old Rust docs output path

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 <[email protected]>
> ---
> 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 <[email protected]>