[Buildroot] [PATCH 1/1] package/tealdeer: new package

[Buildroot] [PATCH 1/1] package/tealdeer: new package

[Danilo Bargen]

Tealdeer is a fast and full-featured tldr client. tldr pages are
simplified and community-driven man pages, see https://tldr.sh/ for more
information.

https://github.com/dbrgn/tealdeer/

Signed-off-by: Danilo Bargen <mail@dbrgn.ch>
---
 DEVELOPERS                     |  1 +
 package/Config.in              |  1 +
 package/tealdeer/Config.in     | 10 ++++++++++
 package/tealdeer/tealdeer.hash |  4 ++++
 package/tealdeer/tealdeer.mk   | 12 ++++++++++++
 5 files changed, 28 insertions(+)
 create mode 100644 package/tealdeer/Config.in
 create mode 100644 package/tealdeer/tealdeer.hash
 create mode 100644 package/tealdeer/tealdeer.mk

diff --git a/DEVELOPERS b/DEVELOPERS
index a91e2dfcde..d2f23968d0 100644
--- a/DEVELOPERS
+++ b/DEVELOPERS
@@ -643,6 +643,7 @@ N:	Daniel Sangue <daniel.sangue@sangue.ch>
 F:	package/libftdi1/

 N:	Danilo Bargen <mail@dbrgn.ch>
+F:  package/tealdeer/
 F:	board/pcengines/apu2/
 F:	configs/pcengines_apu2_defconfig

diff --git a/package/Config.in b/package/Config.in
index 4df1474b91..6e5e69a4f1 100644
--- a/package/Config.in
+++ b/package/Config.in
@@ -2604,6 +2604,7 @@ menu "System tools"
 	source "package/systemd-bootchart/Config.in"
 	source "package/sysvinit/Config.in"
 	source "package/tar/Config.in"
+	source "package/tealdeer/Config.in"
 	source "package/thermald/Config.in"
 	source "package/tpm-tools/Config.in"
 	source "package/tpm2-abrmd/Config.in"
diff --git a/package/tealdeer/Config.in b/package/tealdeer/Config.in
new file mode 100644
index 0000000000..96ed81614b
--- /dev/null
+++ b/package/tealdeer/Config.in
@@ -0,0 +1,10 @@
+config BR2_PACKAGE_TEALDEER
+	bool "tealdeer"
+	depends on BR2_PACKAGE_HOST_RUSTC_TARGET_ARCH_SUPPORTS
+	select BR2_PACKAGE_HOST_RUSTC
+	help
+	  A fast and full-featured tldr client. tldr pages are
+	  simplified and community-driven man pages, see
+	  https://tldr.sh/ for more information.
+
+	  https://github.com/dbrgn/tealdeer/
diff --git a/package/tealdeer/tealdeer.hash b/package/tealdeer/tealdeer.hash
new file mode 100644
index 0000000000..0e53174841
--- /dev/null
+++ b/package/tealdeer/tealdeer.hash
@@ -0,0 +1,4 @@
+# Locally generated
+sha256  42febf9ee84721b9230077d62e2fc51201fd59624d3c776ccc1a634788768a60  tealdeer-1.5.0.tar.gz
+sha256  62c7a1e35f56406896d7aa7ca52d0cc0d272ac022b5d2796e7d6905db8a3636a  LICENSE-APACHE
+sha256  a313b5e62b80a08f3aae0fa62ff3de8482ef55247299eb352ab44f87ef456b1b  LICENSE-MIT
diff --git a/package/tealdeer/tealdeer.mk b/package/tealdeer/tealdeer.mk
new file mode 100644
index 0000000000..c396225098
--- /dev/null
+++ b/package/tealdeer/tealdeer.mk
@@ -0,0 +1,12 @@
+################################################################################
+#
+# tealdeer
+#
+################################################################################
+
+TEALDEER_VERSION = 1.5.0
+TEALDEER_SITE = $(call github,dbrgn,tealdeer,v$(TEALDEER_VERSION))
+TEALDEER_LICENSE = Apache-2.0 or MIT
+TEALDEER_LICENSE_FILES = LICENSE-APACHE LICENSE-MIT
+
+$(eval $(cargo-package))
--
2.34.1

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 1/1] package/tealdeer: new package

[Romain Naour]

Hello Danilo,

Le 17/01/2022 à 00:18, Danilo Bargen a écrit :
> Tealdeer is a fast and full-featured tldr client. tldr pages are
> simplified and community-driven man pages, see https://tldr.sh/ for more
> information.

Is this package really useful for a Buildroot based system?
It's more something for developers.
Also, Buildroot try to not build and install man pages when possible.

Can you share with us why you need this tool on your target system?

Best regards,
Romain

> 
> https://github.com/dbrgn/tealdeer/
> 
> Signed-off-by: Danilo Bargen <mail@dbrgn.ch>
> ---
>  DEVELOPERS                     |  1 +
>  package/Config.in              |  1 +
>  package/tealdeer/Config.in     | 10 ++++++++++
>  package/tealdeer/tealdeer.hash |  4 ++++
>  package/tealdeer/tealdeer.mk   | 12 ++++++++++++
>  5 files changed, 28 insertions(+)
>  create mode 100644 package/tealdeer/Config.in
>  create mode 100644 package/tealdeer/tealdeer.hash
>  create mode 100644 package/tealdeer/tealdeer.mk
> 
> diff --git a/DEVELOPERS b/DEVELOPERS
> index a91e2dfcde..d2f23968d0 100644
> --- a/DEVELOPERS
> +++ b/DEVELOPERS
> @@ -643,6 +643,7 @@ N:	Daniel Sangue <daniel.sangue@sangue.ch>
>  F:	package/libftdi1/
> 
>  N:	Danilo Bargen <mail@dbrgn.ch>
> +F:  package/tealdeer/
>  F:	board/pcengines/apu2/
>  F:	configs/pcengines_apu2_defconfig
> 
> diff --git a/package/Config.in b/package/Config.in
> index 4df1474b91..6e5e69a4f1 100644
> --- a/package/Config.in
> +++ b/package/Config.in
> @@ -2604,6 +2604,7 @@ menu "System tools"
>  	source "package/systemd-bootchart/Config.in"
>  	source "package/sysvinit/Config.in"
>  	source "package/tar/Config.in"
> +	source "package/tealdeer/Config.in"
>  	source "package/thermald/Config.in"
>  	source "package/tpm-tools/Config.in"
>  	source "package/tpm2-abrmd/Config.in"
> diff --git a/package/tealdeer/Config.in b/package/tealdeer/Config.in
> new file mode 100644
> index 0000000000..96ed81614b
> --- /dev/null
> +++ b/package/tealdeer/Config.in
> @@ -0,0 +1,10 @@
> +config BR2_PACKAGE_TEALDEER
> +	bool "tealdeer"
> +	depends on BR2_PACKAGE_HOST_RUSTC_TARGET_ARCH_SUPPORTS
> +	select BR2_PACKAGE_HOST_RUSTC
> +	help
> +	  A fast and full-featured tldr client. tldr pages are
> +	  simplified and community-driven man pages, see
> +	  https://tldr.sh/ for more information.
> +
> +	  https://github.com/dbrgn/tealdeer/
> diff --git a/package/tealdeer/tealdeer.hash b/package/tealdeer/tealdeer.hash
> new file mode 100644
> index 0000000000..0e53174841
> --- /dev/null
> +++ b/package/tealdeer/tealdeer.hash
> @@ -0,0 +1,4 @@
> +# Locally generated
> +sha256  42febf9ee84721b9230077d62e2fc51201fd59624d3c776ccc1a634788768a60  tealdeer-1.5.0.tar.gz
> +sha256  62c7a1e35f56406896d7aa7ca52d0cc0d272ac022b5d2796e7d6905db8a3636a  LICENSE-APACHE
> +sha256  a313b5e62b80a08f3aae0fa62ff3de8482ef55247299eb352ab44f87ef456b1b  LICENSE-MIT
> diff --git a/package/tealdeer/tealdeer.mk b/package/tealdeer/tealdeer.mk
> new file mode 100644
> index 0000000000..c396225098
> --- /dev/null
> +++ b/package/tealdeer/tealdeer.mk
> @@ -0,0 +1,12 @@
> +################################################################################
> +#
> +# tealdeer
> +#
> +################################################################################
> +
> +TEALDEER_VERSION = 1.5.0
> +TEALDEER_SITE = $(call github,dbrgn,tealdeer,v$(TEALDEER_VERSION))
> +TEALDEER_LICENSE = Apache-2.0 or MIT
> +TEALDEER_LICENSE_FILES = LICENSE-APACHE LICENSE-MIT
> +
> +$(eval $(cargo-package))
> --
> 2.34.1
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 1/1] package/tealdeer: new package

[Thomas Petazzoni via buildroot]

Hello Danilo,

Thanks for your contribution!

On Mon, 17 Jan 2022 00:18:14 +0100
Danilo Bargen <mail@dbrgn.ch> wrote:

>  N:	Danilo Bargen <mail@dbrgn.ch>
> +F:  package/tealdeer/
>  F:	board/pcengines/apu2/
>  F:	configs/pcengines_apu2_defconfig

Indentation and alphabetic ordering was not correct here, so I fixed
that.

To be honest, we discussed a bit the usefulness of the package. Indeed,
in Buildroot we unconditionally remove documentation from the target,
as we believe reading/using documentation on the target itself is not
really a valid use-case for Buildroot.

That being said, Arnout was in favor of merging your patch as it was
simple enough, so we did apply it.

Thanks!

Thomas
-- 
Thomas Petazzoni, co-owner and CEO, Bootlin
Embedded Linux and Kernel engineering and training
https://bootlin.com
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 1/1] package/tealdeer: new package

[Danilo Bargen]

Hello Romain and Thomas

Romain Naour wrote:
> Is this package really useful for a Buildroot based system?
> It's more something for developers.
> Also, Buildroot try to not build and install man pages when possible.
>
> Can you share with us why you need this tool on your target system?

For a purely embedded headless system, the package is not really useful, but on a system where administrators actively log in (e.g. a system accessible via SSH, with some administration tools preinstalled) it may be useful as a local command-line based reference documentation for commonly used tools and commands.

I looked at the list of existing packages, and it includes packages like htop which are primarily used for system administration, so I figured tealdeer might be welcome as well. On the other hand, if you decide that man pages are excluded from a target system, then I'd understand if you'd reject the package.

One could argue though that tealdeer does not ship any tldr pages when installing. All tldr pages are fetched and cached at runtime, unlike man pages, where including them for all packages would bloat the target image.

Thomas Petazzoni wrote:
> Indentation and alphabetic ordering was not correct here, so I fixed
> that.

Thank you, I missed that in my original patch!

> That being said, Arnout was in favor of merging your patch as it was
> simple enough, so we did apply it.

Thanks!
Danilo
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 1/1] package/tealdeer: new package

[Thomas Petazzoni via buildroot]

Hello Danilo,

On Wed, 27 Jul 2022 22:25:06 +0200
"Danilo Bargen" <mail@dbrgn.ch> wrote:

> For a purely embedded headless system, the package is not really
> useful, but on a system where administrators actively log in (e.g. a
> system accessible via SSH, with some administration tools
> preinstalled) it may be useful as a local command-line based
> reference documentation for commonly used tools and commands.
> 
> I looked at the list of existing packages, and it includes packages
> like htop which are primarily used for system administration, so I
> figured tealdeer might be welcome as well.

htop is a tool for system monitoring/performance analysis. You can't
run "htop" on your PC to get the information about your target, while
you can run tldr on your PC to get any tldr page, just like on your
target. So you can't compare htop and tldr.

> On the other hand, if you decide that man pages are excluded from a
> target system, then I'd understand if you'd reject the package.

man pages are removed from the target filesystem in Buildroot,
unconditionally. From the target-finalize target in the main Makefile:

        rm -rf $(TARGET_DIR)/usr/man $(TARGET_DIR)/usr/share/man
        rm -rf $(TARGET_DIR)/usr/info $(TARGET_DIR)/usr/share/info
        rm -rf $(TARGET_DIR)/usr/doc $(TARGET_DIR)/usr/share/doc

> One could argue though that tealdeer does not ship any tldr pages
> when installing. All tldr pages are fetched and cached at runtime,
> unlike man pages, where including them for all packages would bloat
> the target image.

It is true that is less heavy than man pages in that regard.

In any case, the patch is applied. I just thought it was useful to
share the discussion/concern we had when discussing whether to merge or
not this new package.

Best regards,

Thomas
-- 
Thomas Petazzoni, co-owner and CEO, Bootlin
Embedded Linux and Kernel engineering and training
https://bootlin.com
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot