Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 533552 - remember to include the http:// part
Summary: remember to include the http:// part
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal trivial
Assignee: Gentoo Devmanual Team
URL: https://devmanual.gentoo.org/quicksta...
Whiteboard:
Keywords:
: 533562 (view as bug list)
Depends on:
Blocks:
 
Reported: 2014-12-25 22:23 UTC by Jonas Stein
Modified: 2020-01-23 13:50 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jonas Stein gentoo-dev 2014-12-25 22:23:46 UTC
The HOMEPAGE is a link to the package's homepage (remember to include the http:// part). 

==> 

 The HOMEPAGE is a link to the package's homepage (remember to include the http:// or https:// part).

Reproducible: Always
Comment 1 Ulrich Müller gentoo-dev 2014-12-26 19:41:01 UTC
*** Bug 533562 has been marked as a duplicate of this bug. ***
Comment 2 Ulrich Müller gentoo-dev 2014-12-26 19:55:46 UTC
Not sure if anything needs to be fixed there. Is it likely that the scheme name would be omitted if it is something other than http?
Comment 3 Sergey Popov (RETIRED) gentoo-dev 2014-12-30 06:22:23 UTC
(In reply to Ulrich Müller from comment #2)
> Not sure if anything needs to be fixed there. Is it likely that the scheme
> name would be omitted if it is something other than http?

In combination with bug #533562 i suggest to rephrase it like

The HOMEPAGE is a link to the package's homepage (it's URL, so remember to include the correct scheme in it)
Comment 4 Jonas Stein gentoo-dev 2014-12-30 09:14:34 UTC
a suggestion from what I have read so far:

==
The HOMEPAGE is a link to the package's homepage and must be one or more space separated complete [[http://en.wikipedia.org/wiki/URI_scheme|URI]]s, or 
[[https://wiki.gentoo.org/wiki/No_homepage]], if no homepage is known. 
The variable is not limited to the http protocol.
==

I am not confident with the last sentence, but I think the scope of protocols should be defined. 

$ grep 'HOMEPAGE=' -R --include="*.ebuild" /usr/portage | cut -d '=' -f 2 | cut -d ':' -f 1 | tr -cd '\n[[:alnum:]]._-' | sort | uniq -c

    442 
      1 BASE_URI
     84 ftp
      5 git
  26967 http
   3486 https

reveals that this is not limited to http websites and should be taken into account for tools, that access the variable one day.
Comment 5 Ulrich Müller gentoo-dev 2014-12-30 18:44:13 UTC
(In reply to Jonas Stein from comment #4)
> ==
> The HOMEPAGE is a link to the package's homepage and must be one or more
> space separated complete [[http://en.wikipedia.org/wiki/URI_scheme|URI]]s,
> or [[https://wiki.gentoo.org/wiki/No_homepage]], if no homepage is known. 
> The variable is not limited to the http protocol.
> ==

Too verbose, for my taste. Remember that this is the "Quickstart Guide", so the language should be rather informal here. We have a separate "Variables" section for the more precise definitions. Also the "no homepage" case occurs only rarely and needs not to be mentioned here (it's already mentioned elsewhere in the devmanual).

How about:
"The HOMEPAGE is a link to the package's homepage (remember to include the URI scheme, for example http:)."
Comment 6 Markos Chandras (RETIRED) gentoo-dev 2015-01-19 20:43:48 UTC
(In reply to Ulrich Müller from comment #5)
> (In reply to Jonas Stein from comment #4)
> > ==
> > The HOMEPAGE is a link to the package's homepage and must be one or more
> > space separated complete [[http://en.wikipedia.org/wiki/URI_scheme|URI]]s,
> > or [[https://wiki.gentoo.org/wiki/No_homepage]], if no homepage is known. 
> > The variable is not limited to the http protocol.
> > ==
> 
> Too verbose, for my taste. Remember that this is the "Quickstart Guide", so
> the language should be rather informal here. We have a separate "Variables"
> section for the more precise definitions. Also the "no homepage" case occurs
> only rarely and needs not to be mentioned here (it's already mentioned
> elsewhere in the devmanual).
> 
> How about:
> "The HOMEPAGE is a link to the package's homepage (remember to include the
> URI scheme, for example http:)."

that's better indeed
Comment 7 Larry the Git Cow gentoo-dev 2020-01-23 13:50:07 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=86d4107e1723f91abe2c3b85dadb55f3dcbf8c58

commit 86d4107e1723f91abe2c3b85dadb55f3dcbf8c58
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2020-01-23 13:08:20 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2020-01-23 13:08:20 +0000

    quickstart: Generalize note about HOMEPAGE.
    
    Closes: https://bugs.gentoo.org/533552
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 quickstart/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)