Skip to contentSkip to conversation

package: add comment about ipkg/opkg/rpm

PATCH New Yann E. MORIN 2 participants 6 messages Aug 20, 2015 – Aug 25, 2015

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 package: add comment about ipkg/opkg/rpm

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.

Cc Thomas Petazzoni <[email protected]>
Cc Peter Korsgaard <[email protected]>

---
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(+)
package/Config.in +13 -0
index 47d14d7..c32c989 100644
@@ -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
Signature · 1 line
1.9.1
#1 lore raw

PATCH 1/1 package: add comment about ipkg/opkg/rpm

Quoted 9 lines · Yann E. MORIN

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

Quoted 18 lines
Cc Thomas Petazzoni <[email protected]>
Cc Peter Korsgaard <[email protected]>

---
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(+)
package/Config.in +0 -0
index 47d14d7..c32c989 100644

package/Config.in endif · line 1380

Quoted 10 lines
package/Config.in +7 -0
@@ -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 *

package/Config.in endif · line 1386

Quoted 6 lines
package/Config.in +6 -0
+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

Quoted 4 lines
package/Config.in +0 -0
 	source "package/ipkg/Config.in"
 	source "package/opkg/Config.in"
 if BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
Signature · 6 lines
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF
#2 lore raw

PATCH 1/1 package: add comment about ipkg/opkg/rpm

Arnout, All,

On 2015-08-23 00:40 +0200, Arnout Vandecappelle spake thusly:

Quoted 7 lines · Yann E. MORIN
Quoted 6 lines

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

Quoted 7 lines
Quoted 3 lines

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--]

Quoted 7 lines
Quoted 7 lines
package/Config.in +0 -0
index 47d14d7..c32c989 100644
@@ -1371,6 +1371,19 @@ endif
 endmenu
 
Quoted 13 lines

package/Config.in endif

Quoted 8 lines
package/Config.in +7 -0
 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...

Quoted 1 line

So I'd stick to the *

Ack.

Quoted 11 lines

package/Config.in endif · line 1386

Quoted 6 lines
package/Config.in +6 -0
+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.

Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
#3 lore raw

PATCH 1/1 package: add comment about ipkg/opkg/rpm

Quoted 3 lines · Yann E. MORIN

Arnout, All,

On 2015-08-23 00:40 +0200, Arnout Vandecappelle spake thusly:

[snip]

Quoted 21 lines
Quoted 5 lines

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 "-----------------------------------------------------"

Quoted 2 lines

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

Signature · 6 lines
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF
#4 lore raw

PATCH 1/1 package: add comment about ipkg/opkg/rpm

Arnout, All,

On 2015-08-24 21:44 +0200, Arnout Vandecappelle spake thusly:

Quoted 24 lines · Yann E. MORIN
Quoted 1 line

On 2015-08-23 00:40 +0200, Arnout Vandecappelle spake thusly:

[snip]

Quoted 21 lines
Quoted 5 lines

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 "-----------------------------------------------------"

Quoted 6 lines
Quoted 2 lines

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?

Quoted 2 lines

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.

Quoted 6 lines

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.

Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
#5 lore raw

PATCH 1/1 package: add comment about ipkg/opkg/rpm

Quoted 5 lines · Yann E. MORIN

Arnout, All,

On 2015-08-24 21:44 +0200, Arnout Vandecappelle spake thusly:

Quoted 2 lines · Yann E. MORIN
Quoted 1 line

On 2015-08-23 00:40 +0200, Arnout Vandecappelle spake thusly:

[snip]

Quoted 5 lines
Quoted 5 lines

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.

Quoted 8 lines
Quoted 1 line

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

Quoted 4 lines

Regards,
Yann E. MORIN.

Signature · 6 lines
Arnout Vandecappelle      arnout dot vandecappelle at essensium dot com
Senior Embedded Software Architect . . . . . . +32-478-010353 (mobile)
Essensium, Mind division . . . . . . . . . . . . . . http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium . . . . . BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF