diff mbox series

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

Message ID 20231018160145.1017340-1-ojeda@kernel.org
State New
Headers
Series [1/2] docs: rust: update Rust docs output path |

Commit Message

Miguel Ojeda Oct. 18, 2023, 4:01 p.m. UTC 
  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(-)


base-commit: 8a749fd1a8720d4619c91c8b6e7528c0a355c0aa

Comments

Benno Lossin Oct. 18, 2023, 5:55 p.m. UTC | #1 
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>
Alice Ryhl Oct. 18, 2023, 9:50 p.m. UTC | #2 
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>
Miguel Ojeda Oct. 18, 2023, 10:57 p.m. UTC | #3 
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
Andreas Hindborg Oct. 19, 2023, 12:03 p.m. UTC | #4 
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
Carlos Bilbao Oct. 23, 2023, 2:43 p.m. UTC | #5 
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>
diff mbox series

Patch

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.