Bug 266992 - emulators/virtualbox-ose[-legacy]: make MANUAL enabled by default
Summary: emulators/virtualbox-ose[-legacy]: make MANUAL enabled by default
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Vladimir Druzenko
URL: https://www.freshports.org/emulators/...
Keywords: easy, needs-patch
Depends on: 266778
Blocks:
  Show dependency treegraph
 
Reported: 2022-10-12 15:46 UTC by Pau Amma
Modified: 2023-05-19 16:01 UTC (History)
2 users (show)

See Also:
bugzilla: maintainer-feedback? (vbox)


Attachments
Add /usr/local/bin:/usr/local/sbin to PATH (1.25 KB, patch)
2023-05-16 16:54 UTC, Vladimir Druzenko
no flags Details | Diff
make option MANUAL on by default (1.75 KB, patch)
2023-05-16 17:42 UTC, Vladimir Druzenko
no flags Details | Diff
make option MANUAL on by default (1.75 KB, patch)
2023-05-16 19:17 UTC, Vladimir Druzenko
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Pau Amma 2022-10-12 15:46:46 UTC
Providing documentation is fairly standard. So is (or should be) looking for it in the right place, in this case (per plist) %%DOCSDIR%%/UserManual.pdf.

Combined, these lead to "Failed to open file:///home/pauamma/.config/VirtualBox/UserManual.pdf. Make sure your desktop environment can properly handle URLs of this type." from Help > Contents and a failure to find the manual in the expected location. Ideally, fix both for seamless manual viewing.

Note: this may also affect emulators/virtualbox-ose-legacy.
Comment 1 Graham Perrin freebsd_committer freebsd_triage 2022-10-13 22:36:01 UTC
Re: bug 266778 comment 0, but without attempting to apply the patch as intended:

After installing a build of emulators/virtualbox-ose with MANUAL=on, 
I manually edited line 16 of the installed 
/usr/local/bin/virtualbox

PATH="/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/usr/local/sbin"

Now, all Help menu options work. Neat!

So, I guess: 

* bug 266778 for a patch to fix the Help menu

* this bug 266992 for an easy patch to add MANUAL to the 
  OPTIONS_DEFAULT line of the Makefile 

<https://cgit.freebsd.org/ports/tree/emulators/virtualbox-ose/Makefile>

<https://cgit.freebsd.org/ports/tree/emulators/virtualbox-ose-legacy/Makefile>
Comment 2 Vladimir Druzenko freebsd_committer freebsd_triage 2023-05-16 16:54:02 UTC
Created attachment 242217 [details]
Add /usr/local/bin:/usr/local/sbin to PATH

(In reply to Graham Perrin from comment #1)
Check patch.
Comment 3 Vladimir Druzenko freebsd_committer freebsd_triage 2023-05-16 17:13:42 UTC
(In reply to Vladimir Druzenko from comment #2)
Oh.
Other PR for this change and it already have same patch.
Comment 4 Vladimir Druzenko freebsd_committer freebsd_triage 2023-05-16 17:42:31 UTC
Created attachment 242219 [details]
make option MANUAL on by default
Comment 5 Vladimir Druzenko freebsd_committer freebsd_triage 2023-05-16 19:17:16 UTC
Created attachment 242220 [details]
make option MANUAL on by default

Fix typo.
Comment 6 Vladimir Druzenko freebsd_committer freebsd_triage 2023-05-16 19:26:10 UTC
https://reviews.freebsd.org/D40118
Comment 7 Vladimir Druzenko freebsd_committer freebsd_triage 2023-05-18 19:56:58 UTC
MANUAL option require very big port print/texlive-texmf for build.
Is it good idea to turn it on by default?
Comment 8 Pau Amma 2023-05-18 20:44:02 UTC
(In reply to Vladimir Druzenko from comment #7)
I'm confused. Is the pkg-plist line
> %%MANUAL%%%%DOCSDIR%%/UserManual.pdf
for the same manual that's (currently) present in ~/.config/VirtualBox/UserManual.pdf and which (must have changed at some point meanwhile) now opens seamlessly from Help > Contents?
Comment 9 Pau Amma 2023-05-18 20:52:11 UTC
(In reply to Pau Amma from comment #8)
Never mind. I just noticed ~/.config/VirtualBox/UserManual.pdf is a holdover from VirtualBox 5.x. So now I'm no longer sure how to best fix the inconsistency, but IMO looking for the manual in the wrong place (where it used to be) and finding an obsolete one violates POLA. I'd much rather have it look in the right place (%%DOCSDIR%%) and not find it if not installed. (I'd also like to have a flavor with the current manual installed so I can use pkg, but that may be a different bug if the current MANUAL off remains.)

What do you think?
Comment 10 commit-hook freebsd_committer freebsd_triage 2023-05-19 15:52:38 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=a0ef5898beb4c6a73e9d94aaa452c0eb37cbb14c

commit a0ef5898beb4c6a73e9d94aaa452c0eb37cbb14c
Author:     Vladimir Druzenko <vvd@FreeBSD.org>
AuthorDate: 2023-05-19 15:50:33 +0000
Commit:     Vladimir Druzenko <vvd@FreeBSD.org>
CommitDate: 2023-05-19 15:50:33 +0000

    emulators/virtualbox-ose[-legacy]: rename option MANUAL to DOCS and make it enabled by default

    PR:                     266992
    Approved by:            arrowd (mentor)
    Differential Revision:  https://reviews.freebsd.org/D40118

 emulators/virtualbox-ose-legacy/Makefile  | 13 ++++++-------
 emulators/virtualbox-ose-legacy/pkg-plist |  2 +-
 emulators/virtualbox-ose/Makefile         | 12 ++++++------
 emulators/virtualbox-ose/pkg-plist        |  2 +-
 4 files changed, 14 insertions(+), 15 deletions(-)
Comment 11 Vladimir Druzenko freebsd_committer freebsd_triage 2023-05-19 16:01:58 UTC
(In reply to Pau Amma from comment #9)
Check /usr/local/share/doc/virtualbox-ose.