linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 1/2] docs: move Linux logo into a new `images` folder
@ 2022-05-28 15:31 Miguel Ojeda
  2022-05-29  0:24 ` Bagas Sanjaya
                   ` (2 more replies)
  0 siblings, 3 replies; 5+ messages in thread
From: Miguel Ojeda @ 2022-05-28 15:31 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Garrett LeSage, IFo Hancroft, linux-doc, linux-kernel,
	Miguel Ojeda

Having assets in the top-level `Documentation` directory can make
it harder to find the documents one needs, especially if we want
to add more of them later on.

Instead, create a new `images` folder inside it that is used
to hold assets such as logos.

In addition, update the reference in `scripts/spdxcheck-test.sh`.

Link: https://lore.kernel.org/lkml/8735hicoy7.fsf@meer.lwn.net/
Suggested-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
v1: https://lore.kernel.org/lkml/20220510172530.29704-1-ojeda@kernel.org/
v2:
  - Added the `scripts/spdxcheck-test.sh` reference update, as noticed
    by Jonathan Corbet.

  |   0
 Documentation/{ => images}/logo.gif     | Bin
 scripts/spdxcheck-test.sh               |   2 +-
 3 files changed, 1 insertion(+), 1 deletion(-)
 rename Documentation/{ => images}/COPYING-logo (100%)
 rename Documentation/{ => images}/logo.gif (100%)

diff --git a/Documentation/COPYING-logo b/Documentation/images/COPYING-logo
similarity index 100%
rename from Documentation/COPYING-logo
rename to Documentation/images/COPYING-logo
diff --git a/Documentation/logo.gif b/Documentation/images/logo.gif
similarity index 100%
rename from Documentation/logo.gif
rename to Documentation/images/logo.gif
diff --git a/scripts/spdxcheck-test.sh b/scripts/spdxcheck-test.sh
index cb76324756bd..9f6d1a74da6e 100644
--- a/scripts/spdxcheck-test.sh
+++ b/scripts/spdxcheck-test.sh
@@ -1,7 +1,7 @@
 #!/bin/sh
 
 # run check on a text and a binary file
-for FILE in Makefile Documentation/logo.gif; do
+for FILE in Makefile Documentation/images/logo.gif; do
 	python3 scripts/spdxcheck.py $FILE
 	python3 scripts/spdxcheck.py - < $FILE
 done

base-commit: 4b0986a3613c92f4ec1bdc7f60ec66fea135991f
-- 
2.36.1


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

* Re: [PATCH v2 1/2] docs: move Linux logo into a new `images` folder
  2022-05-28 15:31 [PATCH v2 1/2] docs: move Linux logo into a new `images` folder Miguel Ojeda
@ 2022-05-29  0:24 ` Bagas Sanjaya
  2022-05-29 14:27   ` Jonathan Corbet
  2022-06-01 15:33 ` Jonathan Corbet
       [not found] ` <20220528153132.8636-2-ojeda@kernel.org>
  2 siblings, 1 reply; 5+ messages in thread
From: Bagas Sanjaya @ 2022-05-29  0:24 UTC (permalink / raw)
  To: Miguel Ojeda, Jonathan Corbet
  Cc: Garrett LeSage, IFo Hancroft, linux-doc, linux-kernel

On 5/28/22 22:31, Miguel Ojeda wrote:
> Having assets in the top-level `Documentation` directory can make
> it harder to find the documents one needs, especially if we want
> to add more of them later on.
> 
> Instead, create a new `images` folder inside it that is used
> to hold assets such as logos.
> 

Do assets include CSS and JS files?

And if we plan to add non-image assets to images/, that directory will
be misleading. I suggest to name the directory as assets/.

-- 
An old man doll... just what I always wanted! - Clara

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

* Re: [PATCH v2 1/2] docs: move Linux logo into a new `images` folder
  2022-05-29  0:24 ` Bagas Sanjaya
@ 2022-05-29 14:27   ` Jonathan Corbet
  0 siblings, 0 replies; 5+ messages in thread
From: Jonathan Corbet @ 2022-05-29 14:27 UTC (permalink / raw)
  To: Bagas Sanjaya, Miguel Ojeda
  Cc: Garrett LeSage, IFo Hancroft, linux-doc, linux-kernel

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> On 5/28/22 22:31, Miguel Ojeda wrote:
>> Having assets in the top-level `Documentation` directory can make
>> it harder to find the documents one needs, especially if we want
>> to add more of them later on.
>> 
>> Instead, create a new `images` folder inside it that is used
>> to hold assets such as logos.
>> 
>
> Do assets include CSS and JS files?
>
> And if we plan to add non-image assets to images/, that directory will
> be misleading. I suggest to name the directory as assets/.

Can you please point out any CSS or JavaScript files in the kernel tree,
or any that we might expect to have there anytime soon?  I don't think
this is a case we need to be worried about.

Thanks,

jon

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

* Re: [PATCH v2 1/2] docs: move Linux logo into a new `images` folder
  2022-05-28 15:31 [PATCH v2 1/2] docs: move Linux logo into a new `images` folder Miguel Ojeda
  2022-05-29  0:24 ` Bagas Sanjaya
@ 2022-06-01 15:33 ` Jonathan Corbet
       [not found] ` <20220528153132.8636-2-ojeda@kernel.org>
  2 siblings, 0 replies; 5+ messages in thread
From: Jonathan Corbet @ 2022-06-01 15:33 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: Garrett LeSage, IFo Hancroft, linux-doc, linux-kernel,
	Miguel Ojeda

Miguel Ojeda <ojeda@kernel.org> writes:

> Having assets in the top-level `Documentation` directory can make
> it harder to find the documents one needs, especially if we want
> to add more of them later on.
>
> Instead, create a new `images` folder inside it that is used
> to hold assets such as logos.

Both patches applied, thanks.

jon

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

* Re: [PATCH v2 2/2] docs: add SVG version of the Linux logo
       [not found] ` <20220528153132.8636-2-ojeda@kernel.org>
@ 2022-06-02  7:39   ` Geert Uytterhoeven
  0 siblings, 0 replies; 5+ messages in thread
From: Geert Uytterhoeven @ 2022-06-02  7:39 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: Jonathan Corbet, Garrett LeSage, IFo Hancroft,
	open list:DOCUMENTATION, Linux Kernel Mailing List

Hi Miguel,

On Sat, May 28, 2022 at 10:15 PM Miguel Ojeda <ojeda@kernel.org> wrote:
> In the Rust for Linux patch series, Jonathan Corbet requested [1] that
> we avoid binary assets (such as the logo), possibly by recreating
> them in SVG format.
>
> However, it turns out there is no SVG version of the Linux logo
> in the kernel tree yet, only a GIF one from the pre-v2.0.0 days.
>
> This patch fixes that by adding a SVG version of the Linux logo,
> which we could then use in the Rust for Linux documentation and
> other similar places.

Perhaps you want to add a Rust logo to drivers/video/logo/, to be
shown using fb_append_extra_logo() when Rust technology is included?

;-)

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds

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

end of thread, other threads:[~2022-06-02  7:40 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-05-28 15:31 [PATCH v2 1/2] docs: move Linux logo into a new `images` folder Miguel Ojeda
2022-05-29  0:24 ` Bagas Sanjaya
2022-05-29 14:27   ` Jonathan Corbet
2022-06-01 15:33 ` Jonathan Corbet
     [not found] ` <20220528153132.8636-2-ojeda@kernel.org>
2022-06-02  7:39   ` [PATCH v2 2/2] docs: add SVG version of the Linux logo Geert Uytterhoeven

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