linux-kernel - Re: [PATCH] rust: docs: fix logo replacement

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87o7guizsn.fsf@samsung.com>
Date:   Thu, 19 Oct 2023 12:04:30 +0000
From:   Andreas Hindborg <a.hindborg@...sung.com>
To:     Miguel Ojeda <ojeda@...nel.org>
CC:     Wedson Almeida Filho <wedsonaf@...il.com>,
        Alex Gaynor <alex.gaynor@...il.com>,
        Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
        Björn Roy Baron <bjorn3_gh@...tonmail.com>,
        Benno Lossin <benno.lossin@...ton.me>,
        Alice Ryhl <aliceryhl@...gle.com>,
        "rust-for-linux@...r.kernel.org" <rust-for-linux@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        "patches@...ts.linux.dev" <patches@...ts.linux.dev>,
        "stable@...r.kernel.org" <stable@...r.kernel.org>
Subject: Re: [PATCH] rust: docs: fix logo replacement


Miguel Ojeda <ojeda@...nel.org> writes:

> The static files placement by `rustdoc` changed in Rust 1.67.0 [1],
> but the custom code we have to replace the logo in the generated
> HTML files did not get updated.
>
> Thus update it to have the Linux logo again in the output.
>
> Hopefully `rustdoc` will eventually support a custom logo from
> a local file [2], so that we do not need to maintain this hack
> on our side.
>
> Link: https://protect2.fireeye.com/v1/url?k=3606269f-578d33a5-3607add0-74fe4860008a-47cdfdc2f1793629&q=1&e=ca2ce79b-669b-4a80-b032-30bab50cf455&u=https%3A%2F%2Fgithub.com%2Frust-lang%2Frust%2Fpull%2F101702 [1]
> Link: https://protect2.fireeye.com/v1/url?k=faa866e4-9b2373de-faa9edab-74fe4860008a-e32c39efb11c5865&q=1&e=ca2ce79b-669b-4a80-b032-30bab50cf455&u=https%3A%2F%2Fgithub.com%2Frust-lang%2Frfcs%2Fpull%2F3226 [2]
> Fixes: 3ed03f4da06e ("rust: upgrade to Rust 1.68.2")
> Cc: stable@...r.kernel.org
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>

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

> ---
>  rust/Makefile | 15 +++++++--------
>  1 file changed, 7 insertions(+), 8 deletions(-)
>
> diff --git a/rust/Makefile b/rust/Makefile
> index 87958e864be0..08af1f869f0c 100644
> --- a/rust/Makefile
> +++ b/rust/Makefile
> @@ -93,15 +93,14 @@ quiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_host),H, ) $<
>  # and then retouch the generated files.
>  rustdoc: rustdoc-core rustdoc-macros rustdoc-compiler_builtins \
>      rustdoc-alloc rustdoc-kernel
> -	$(Q)cp $(srctree)/Documentation/images/logo.svg $(rustdoc_output)
> -	$(Q)cp $(srctree)/Documentation/images/COPYING-logo $(rustdoc_output)
> +	$(Q)cp $(srctree)/Documentation/images/logo.svg $(rustdoc_output)/static.files/
> +	$(Q)cp $(srctree)/Documentation/images/COPYING-logo $(rustdoc_output)/static.files/
>  	$(Q)find $(rustdoc_output) -name '*.html' -type f -print0 | xargs -0 sed -Ei \
> -		-e 's:rust-logo\.svg:logo.svg:g' \
> -		-e 's:rust-logo\.png:logo.svg:g' \
> -		-e 's:favicon\.svg:logo.svg:g' \
> -		-e 's:<link rel="alternate icon" type="image/png" href="[./]*favicon-(16x16|32x32)\.png">::g'
> -	$(Q)echo '.logo-container > img { object-fit: contain; }' \
> -		>> $(rustdoc_output)/rustdoc.css
> +		-e 's:rust-logo-[0-9a-f]+\.svg:logo.svg:g' \
> +		-e 's:favicon-[0-9a-f]+\.svg:logo.svg:g' \
> +		-e 's:<link rel="alternate icon" type="image/png" href="[/.]+/static\.files/favicon-(16x16|32x32)-[0-9a-f]+\.png">::g'
> +	$(Q)for f in $(rustdoc_output)/static.files/rustdoc-*.css; do \
> +		echo ".logo-container > img { object-fit: contain; }" >> $$f; done
>  
>  rustdoc-macros: private rustdoc_host = yes
>  rustdoc-macros: private rustc_target_flags = --crate-type proc-macro \