public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Andreas Hindborg <a.hindborg@samsung.com>
To: Miguel Ojeda <ojeda@kernel.org>
Cc: "Wedson Almeida Filho" <wedsonaf@gmail.com>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <benno.lossin@proton.me>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"rust-for-linux@vger.kernel.org" <rust-for-linux@vger.kernel.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	"patches@lists.linux.dev" <patches@lists.linux.dev>,
	"stable@vger.kernel.org" <stable@vger.kernel.org>
Subject: Re: [PATCH] rust: docs: fix logo replacement
Date: Thu, 19 Oct 2023 12:04:30 +0000	[thread overview]
Message-ID: <87o7guizsn.fsf@samsung.com> (raw)
In-Reply-To: <20231018155527.1015059-1-ojeda@kernel.org>


Miguel Ojeda <ojeda@kernel.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@vger.kernel.org
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Andreas Hindborg <a.hindborg@samsung.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 \

      parent reply	other threads:[~2023-10-19 12:07 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <CGME20231018155602eucas1p14b9439c5249a921e1d5eda1e2e23eebf@eucas1p1.samsung.com>
2023-10-18 15:55 ` [PATCH] rust: docs: fix logo replacement Miguel Ojeda
2023-10-18 16:36   ` Miguel Ojeda
2023-10-18 17:51   ` Benno Lossin
2023-10-18 22:57   ` Miguel Ojeda
2023-10-19 12:04   ` Andreas Hindborg [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87o7guizsn.fsf@samsung.com \
    --to=a.hindborg@samsung.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=benno.lossin@proton.me \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=gary@garyguo.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ojeda@kernel.org \
    --cc=patches@lists.linux.dev \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=stable@vger.kernel.org \
    --cc=wedsonaf@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox