diff mbox

package: add comment about ipkg/opkg/rpm

Message ID 1440085901-24479-1-git-send-email-yann.morin.1998@free.fr
State Changes Requested
Headers show

Commit Message

Yann E. MORIN Aug. 20, 2015, 3:51 p.m. UTC
Too often the question is raised, that ipkg, opkg and rpm do not work,
and users complain they can not install packages.

Even though we do have a clear and clearly explained section in our
manual, people do not read it (when will users read manuals? sigh...).

So, add a big fat comment about ipkg/opkg/rpm, that Buildroot does not
generate binary packages and does not provide any package database for
any of those package manager.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Peter Korsgaard <jacmet@uclibc.org>

---
Please note the little dirty trick to avoid kconfig eating up all spaces
on empty lines: the first space in those is U+00A0 (NO-BREAK SPACE). It
differs from the legacy menu, where we use a single '*' to avoid that.
---
 package/Config.in | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Arnout Vandecappelle Aug. 22, 2015, 10:40 p.m. UTC | #1
On 08/20/2015 05:51 PM, Yann E. MORIN wrote:
> Too often the question is raised, that ipkg, opkg and rpm do not work,
> and users complain they can not install packages.
> 
> Even though we do have a clear and clearly explained section in our
> manual, people do not read it (when will users read manuals? sigh...).
> 
> So, add a big fat comment about ipkg/opkg/rpm, that Buildroot does not
> generate binary packages and does not provide any package database for
> any of those package manager.

 Great plan!

 And guess what: not a single spelling mistake! Congrats, Yann!

 However...

> 
> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
> Cc: Peter Korsgaard <jacmet@uclibc.org>
> 
> ---
> Please note the little dirty trick to avoid kconfig eating up all spaces
> on empty lines: the first space in those is U+00A0 (NO-BREAK SPACE). It
> differs from the legacy menu, where we use a single '*' to avoid that.
> ---
>  package/Config.in | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/package/Config.in b/package/Config.in
> index 47d14d7..c32c989 100644
> --- a/package/Config.in
> +++ b/package/Config.in
> @@ -1371,6 +1371,19 @@ endif
>  endmenu
>  
>  menu "Package managers"
> +comment "------------------------------------------------------------------------"
> +comment "Please note:                                                            "
> +comment "- Buildroot does *not* generate binary packages,                        "
> +comment "- Buildroot does *not* install any package database.                    "
> +# First space is U+00A0 (NO-BREAK SPACE), otherwise kconfig eats
> +# up all spaces:
> +comment "                                                                        "

 Nice trick, however:
- it requires a UTF-8 terminal;
- it breaks completely in nconfig;
- in menuconfig, the final *** gets shifted by one space when I tried.

 So I'd stick to the *

> +comment "It is up to you to provide those by yourself if you want                "
> +comment "to use any of those package managers.                                   "
> +comment "                                                                        "
> +comment "See the manual:                                                         "
> +comment "http://buildroot.org/downloads/manual/manual.html#faq-no-binary-packages"
> +comment "------------------------------------------------------------------------"

 Don't know how important this is, but on a 80-character display it gets chopped
off after the faq-no-. But I guess there's not much we can do about it.
Except perhaps: http://nightly.buildroot.org/manual.html#faq-no-binary-packages
- still doesn't fit but at least we get to the binary-pa :-)


 Regards,
 Arnout

>  	source "package/ipkg/Config.in"
>  	source "package/opkg/Config.in"
>  if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
>
Yann E. MORIN Aug. 23, 2015, 9:47 a.m. UTC | #2
Arnout, All,

On 2015-08-23 00:40 +0200, Arnout Vandecappelle spake thusly:
> On 08/20/2015 05:51 PM, Yann E. MORIN wrote:
> > Too often the question is raised, that ipkg, opkg and rpm do not work,
> > and users complain they can not install packages.
> > 
> > Even though we do have a clear and clearly explained section in our
> > manual, people do not read it (when will users read manuals? sigh...).
> > 
> > So, add a big fat comment about ipkg/opkg/rpm, that Buildroot does not
> > generate binary packages and does not provide any package database for
> > any of those package manager.
> 
>  Great plan!
> 
>  And guess what: not a single spelling mistake! Congrats, Yann!

Well, it's usually not spelling mistakes, but keyboard-dislexia. ;-]

[--SNIP--]
> > diff --git a/package/Config.in b/package/Config.in
> > index 47d14d7..c32c989 100644
> > --- a/package/Config.in
> > +++ b/package/Config.in
> > @@ -1371,6 +1371,19 @@ endif
> >  endmenu
> >  
> >  menu "Package managers"
> > +comment "------------------------------------------------------------------------"
> > +comment "Please note:                                                            "
> > +comment "- Buildroot does *not* generate binary packages,                        "
> > +comment "- Buildroot does *not* install any package database.                    "
> > +# First space is U+00A0 (NO-BREAK SPACE), otherwise kconfig eats
> > +# up all spaces:
> > +comment "                                                                        "
> 
>  Nice trick, however:
> - it requires a UTF-8 terminal;
> - it breaks completely in nconfig;
> - in menuconfig, the final *** gets shifted by one space when I tried.

OK. Bad idea...

>  So I'd stick to the *

Ack.

> > +comment "It is up to you to provide those by yourself if you want                "
> > +comment "to use any of those package managers.                                   "
> > +comment "                                                                        "
> > +comment "See the manual:                                                         "
> > +comment "http://buildroot.org/downloads/manual/manual.html#faq-no-binary-packages"
> > +comment "------------------------------------------------------------------------"
> 
>  Don't know how important this is, but on a 80-character display it gets chopped
> off after the faq-no-. But I guess there's not much we can do about it.
> Except perhaps: http://nightly.buildroot.org/manual.html#faq-no-binary-packages
> - still doesn't fit but at least we get to the binary-pa :-)

What about;

    comment "-----------------------------------------------------"
    comment "Please note:                                         "
    comment "- Buildroot does *not* generate binary packages,     "
    comment "- Buildroot does *not* install any package database. "
    comment "*                                                    "
    comment "It is up to you to provide those by yourself if you  "
    comment "want to use any of those package managers.           "
    comment "*                                                    "
    comment "See the manual:                                      "
    comment "http://buildroot.org/downloads/manual/manaul.html#faq"
    comment "-no-binary-packages                                  "
    comment "-----------------------------------------------------"

This does fit on a 80-char wide terminal, and we get the complete URL on
two lines.

Regards,
Yann E. MORIN.
Arnout Vandecappelle Aug. 24, 2015, 7:44 p.m. UTC | #3
On 08/23/2015 11:47 AM, Yann E. MORIN wrote:
> Arnout, All,
> 
> On 2015-08-23 00:40 +0200, Arnout Vandecappelle spake thusly:
[snip]
>>
>>  Don't know how important this is, but on a 80-character display it gets chopped
>> off after the faq-no-. But I guess there's not much we can do about it.
>> Except perhaps: http://nightly.buildroot.org/manual.html#faq-no-binary-packages
>> - still doesn't fit but at least we get to the binary-pa :-)
> 
> What about;
> 
>     comment "-----------------------------------------------------"
>     comment "Please note:                                         "
>     comment "- Buildroot does *not* generate binary packages,     "
>     comment "- Buildroot does *not* install any package database. "
>     comment "*                                                    "
>     comment "It is up to you to provide those by yourself if you  "
>     comment "want to use any of those package managers.           "
>     comment "*                                                    "
>     comment "See the manual:                                      "
>     comment "http://buildroot.org/downloads/manual/manaul.html#faq"
>     comment "-no-binary-packages                                  "
>     comment "-----------------------------------------------------"
> 
> This does fit on a 80-char wide terminal, and we get the complete URL on
> two lines.

 ... which is also not ideal, since it means that the URL can't be copy&paste'd
easily, and that people with a modern terminal that is more than 80 characters
wide can't ctrl-click (or whatever) to open the URL directly.

 So I think it's best to use the slightly shorter nightly URL and keep it
non-wrapped.

 Or actually, it's best to add a manual.html -> downloads/manual/manual.html
symlink to the website and refer to that. This fits easily:
http://buildroot.org/manual.html#faq-no-binary-packages
And it also makes it easier for us to refer to the manual in other places.

 Peter, what do you think of such a symlink?


 Regards,
 Arnout
Yann E. MORIN Aug. 24, 2015, 8:34 p.m. UTC | #4
Arnout, All,

On 2015-08-24 21:44 +0200, Arnout Vandecappelle spake thusly:
> On 08/23/2015 11:47 AM, Yann E. MORIN wrote:
> > On 2015-08-23 00:40 +0200, Arnout Vandecappelle spake thusly:
> [snip]
> >>
> >>  Don't know how important this is, but on a 80-character display it gets chopped
> >> off after the faq-no-. But I guess there's not much we can do about it.
> >> Except perhaps: http://nightly.buildroot.org/manual.html#faq-no-binary-packages
> >> - still doesn't fit but at least we get to the binary-pa :-)
> > 
> > What about;
> > 
> >     comment "-----------------------------------------------------"
> >     comment "Please note:                                         "
> >     comment "- Buildroot does *not* generate binary packages,     "
> >     comment "- Buildroot does *not* install any package database. "
> >     comment "*                                                    "
> >     comment "It is up to you to provide those by yourself if you  "
> >     comment "want to use any of those package managers.           "
> >     comment "*                                                    "
> >     comment "See the manual:                                      "
> >     comment "http://buildroot.org/downloads/manual/manaul.html#faq"
> >     comment "-no-binary-packages                                  "
> >     comment "-----------------------------------------------------"
> > 
> > This does fit on a 80-char wide terminal, and we get the complete URL on
> > two lines.
> 
>  ... which is also not ideal, since it means that the URL can't be copy&paste'd
> easily, and that people with a modern terminal that is more than 80 characters
> wide can't ctrl-click (or whatever) to open the URL directly.

Right, but then, it's better than npthing, no?

>  So I think it's best to use the slightly shorter nightly URL and keep it
> non-wrapped.

I would not like we use the nightly version, just because nightly is
not stable.

>  Or actually, it's best to add a manual.html -> downloads/manual/manual.html
> symlink to the website and refer to that. This fits easily:
> http://buildroot.org/manual.html#faq-no-binary-packages
> And it also makes it easier for us to refer to the manual in other places.
> 
>  Peter, what do you think of such a symlink?

At least, I'd like that.

Since I have access to the server, if Peter agrees, I can try to
configure the apache server for that.

But note that this apache server also serves ulibc and busybox.

Regards,
Yann E. MORIN.
Arnout Vandecappelle Aug. 25, 2015, 8:30 a.m. UTC | #5
On 08/24/2015 10:34 PM, Yann E. MORIN wrote:
> Arnout, All,
> 
> On 2015-08-24 21:44 +0200, Arnout Vandecappelle spake thusly:
>> On 08/23/2015 11:47 AM, Yann E. MORIN wrote:
>>> On 2015-08-23 00:40 +0200, Arnout Vandecappelle spake thusly:
[snip]
>>  Or actually, it's best to add a manual.html -> downloads/manual/manual.html
>> symlink to the website and refer to that. This fits easily:
>> http://buildroot.org/manual.html#faq-no-binary-packages
>> And it also makes it easier for us to refer to the manual in other places.
>>
>>  Peter, what do you think of such a symlink?
> 
> At least, I'd like that.
> 
> Since I have access to the server, if Peter agrees, I can try to
> configure the apache server for that.
> 
> But note that this apache server also serves ulibc and busybox.

 Just do
ln -s downloads/manual/manual.html docs/website/manual.html
git add docs/website/manual.html

 It results in a dead link in our repo, but who looks at the docs/website
directory anyway?

 Regards,
 Arnout

> 
> Regards,
> Yann E. MORIN.
>
diff mbox

Patch

diff --git a/package/Config.in b/package/Config.in
index 47d14d7..c32c989 100644
--- a/package/Config.in
+++ b/package/Config.in
@@ -1371,6 +1371,19 @@  endif
 endmenu
 
 menu "Package managers"
+comment "------------------------------------------------------------------------"
+comment "Please note:                                                            "
+comment "- Buildroot does *not* generate binary packages,                        "
+comment "- Buildroot does *not* install any package database.                    "
+# First space is U+00A0 (NO-BREAK SPACE), otherwise kconfig eats
+# up all spaces:
+comment "                                                                        "
+comment "It is up to you to provide those by yourself if you want                "
+comment "to use any of those package managers.                                   "
+comment "                                                                        "
+comment "See the manual:                                                         "
+comment "http://buildroot.org/downloads/manual/manual.html#faq-no-binary-packages"
+comment "------------------------------------------------------------------------"
 	source "package/ipkg/Config.in"
 	source "package/opkg/Config.in"
 if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS