Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update package descriptions and messages for some VirtualBox ports #115

Closed
wants to merge 17 commits into from
Closed

Update package descriptions and messages for some VirtualBox ports #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
df3ef9f
Update pkg-message for bugs 254266 and 254412
grahamperrin Oct 10, 2021
991ba99
Make the package description more explanatory
grahamperrin Oct 10, 2021
945efe4
Make the package description more explanatory
grahamperrin Oct 10, 2021
df4f870
Update the legacy package description
grahamperrin Oct 10, 2021
41c24e7
Update legacy pkg-message, partly for bug 254266
grahamperrin Oct 10, 2021
2cdeeef
Make pkg-message advice more resilient to panics
grahamperrin Oct 17, 2021
571ebe9
Make legacy package message advice consistent
grahamperrin Oct 17, 2021
266c327
Remove 'Oracle' and ⓡ from legacy package message
grahamperrin Oct 17, 2021
98bc7e8
Improve legacy package description
grahamperrin Oct 17, 2021
509a45e
Remove 'Oracle' and ⓡ from package message
grahamperrin Oct 17, 2021
5fe0fe3
Improve package description
grahamperrin Oct 17, 2021
2ebbfeb
Remove ⓡ from the legacy package description
grahamperrin Oct 17, 2021
34b647f
Improve the legacy package description
grahamperrin Oct 18, 2021
8dfdbfa
Improve the primary package description
grahamperrin Oct 18, 2021
77cbe56
Exclude use of service(8) from legacy pkg-message
grahamperrin Oct 18, 2021
006a073
Exclude use of service(8) from pkg-message
grahamperrin Oct 18, 2021
e5b25c7
pkg-message clarity re: startup panic situations
grahamperrin Oct 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 12 additions & 6 deletions emulators/virtualbox-ose-additions-legacy/pkg-descr
View file
Open in desktop
@@ -1,9 +1,15 @@
These additions are for installation inside a FreeBSD guest.
VirtualBox Guest Additions provide closer integration between host and
guest, and improve the performance of guest systems.

VirtualBox is a family of powerful x86 virtualization products for
enterprise as well as home use. Not only is VirtualBox an extremely
feature rich, high performance product for enterprise customers, it
is also the only professional solution that is freely available as
Open Source Software under the terms of the GNU General Public License.
Non-legacy additions i.e. emulators/virtualbox-ose-additions are
recommended for most use cases.

Where legacy (5.2.x) is a requirement, this FreeBSD-provided package
can be installed in the FreeBSD guest machine.

<https://www.virtualbox.org/wiki/Changelog-5.2> emphasises that
5.2.x is no longer supported by Oracle.

Addition to host machines is not required.

WWW: https://www.virtualbox.org/
23 changes: 12 additions & 11 deletions emulators/virtualbox-ose-additions-legacy/pkg-message
View file
Open in desktop
@@ -1,23 +1,24 @@
[
{ type: install
message: <<EOM
VirtualBox Guest Additions were installed.
VirtualBox Guest Additions are installed.

To enable the required services:

You need to enable the vboxguest startscript to load the kernel module and
vboxservice to use host time synchronization.
# sysrc vboxguest_enable="YES"
# sysrc vboxservice_enable="YES"

vboxguest_enable="YES"
vboxservice_enable="YES"
To start the services, restart the system.
grahamperrin marked this conversation as resolved.
Show resolved Hide resolved

You also have to add all X11 users that want to use any of the additional
features (clipboard sharing, window scaling) to the wheel group.
For features such as window scaling and clipboard sharing, membership of
the wheel group is required. With username jerry as an example:
grahamperrin marked this conversation as resolved.
Show resolved Hide resolved

% pw groupmod wheel -m jerry
# pw groupmod wheel -m jerry

Reboot the machine to load the needed kernel modules.

For detailed informations please visit http://wiki.freebsd.org/VirtualBox
The settings dialogue for FreeBSD guests encourages use of the VMSVGA
graphics controller. Whilst this might suit installations of FreeBSD
without a desktop environment (a common use case), it may be inappropriate
where legacy Guest Additions are installed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is about the legacy additions, I have not experimented but I think in this case the best choice is the old VBoxVGA driver.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

Shall we write VBoxVGA into the message? Then if someone who does experiment finds fault, the message can be reviewed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obviously we can always improve this.

But please remember what the porter's guide says here: https://docs.freebsd.org/en/books/porters-handbook/quick-porting/#porting-desc (first info box)

I'll cite here the relevant part:

This is not a manual or an in-depth description on how to use or compile the port! Please be careful when copying from the README or manpage. Too often they are not a concise description of the port or are in an awkward format. For example, manpages have justified spacing, which looks particularly bad with monospaced fonts.

Especially the warning about just copying from upstream documentation and other material applies here. This implies that the fact something is included in upstream documentation does not make it automatically correct in the pkg-descr.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for guidance. Much appreciated.

EOM
}
]
11 changes: 5 additions & 6 deletions emulators/virtualbox-ose-additions/pkg-descr
View file
Open in desktop
@@ -1,9 +1,8 @@
These additions are for installation inside a FreeBSD guest.
VirtualBox Guest Additions provide closer integration between host and
guest, and improve the performance of guest systems.

VirtualBox is a family of powerful x86 virtualization products for
enterprise as well as home use. Not only is VirtualBox an extremely
feature rich, high performance product for enterprise customers, it
is also the only professional solution that is freely available as
Open Source Software under the terms of the GNU General Public License.
This FreeBSD-provided package can be installed in FreeBSD guest machines.

Addition to host machines is not required.

WWW: https://www.virtualbox.org/
33 changes: 23 additions & 10 deletions emulators/virtualbox-ose-additions/pkg-message
View file
Open in desktop
@@ -1,23 +1,36 @@
[
{ type: install
message: <<EOM
VirtualBox Guest Additions were installed.
VirtualBox Guest Additions are installed.

To enable and start the required services:

You need to enable the vboxguest startscript to load the kernel module and
vboxservice to use host time synchronization.
# sysrc vboxguest_enable="YES"
# sysrc vboxservice_enable="YES"

vboxguest_enable="YES"
vboxservice_enable="YES"
To start the services, restart the system.

You also have to add all X11 users that want to use any of the additional
features (clipboard sharing, window scaling) to the wheel group.
In some situations, a panic will occur when the kernel module loads.
Having no more than one virtual CPU might mitigate the issue.

% pw groupmod wheel -m jerry
For features such as window scaling and clipboard sharing, membership of
the wheel group is required. With username jerry as an example:

Reboot the machine to load the needed kernel modules.
# pw groupmod wheel -m jerry

For detailed informations please visit http://wiki.freebsd.org/VirtualBox
The settings dialogue for FreeBSD guests encourages use of the VMSVGA
graphics controller. Whilst this might suit installations of FreeBSD
without a desktop environment (a common use case), it is not appropriate
where Guest Additions are installed.

Where Guest Additions are installed:

1. prefer VBoxSVGA

2. do not enable 3D acceleration (doing so will invisibly
lose the preference for VBoxSVGA)

– you may ignore the yellow alert that encourages use of VMSVGA.
EOM
}
]
22 changes: 17 additions & 5 deletions emulators/virtualbox-ose-legacy/pkg-descr
View file
Open in desktop
@@ -1,7 +1,19 @@
VirtualBox is a family of powerful x86 virtualization products for
enterprise as well as home use. Not only is VirtualBox an extremely
feature rich, high performance product for enterprise customers, it
is also the only professional solution that is freely available as
Open Source Software under the terms of the GNU General Public License.
Oracle VM VirtualBox is a hosted hypervisor for x86 virtualisation.
Supported guests include BSD, Haiku, Linux, OS/2, ReactOS, Solaris and
Windows.

emulators/virtualbox-ose is recommended for most use cases.

emulators/virtualbox-ose-legacy is for exceptional legacy (5.2.x) cases.

<https://www.virtualbox.org/wiki/Changelog-5.2> emphasises that
5.2.x is no longer supported by Oracle.

Guest Additions are available:

emulators/virtualbox-ose-additions-legacy

For the Extension Pack: FreeBSD is not a supported host platform.
Installation of the Pack will not extend the feature set.

WWW: https://www.virtualbox.org/
15 changes: 10 additions & 5 deletions emulators/virtualbox-ose/pkg-descr
View file
Open in desktop
@@ -1,7 +1,12 @@
VirtualBox is a family of powerful x86 virtualization products for
enterprise as well as home use. Not only is VirtualBox an extremely
feature rich, high performance product for enterprise customers, it
is also the only professional solution that is freely available as
Open Source Software under the terms of the GNU General Public License.
Oracle VM VirtualBox is a hosted hypervisor for x86 virtualisation.
Supported guests include BSD, Haiku, Linux, OS/2, ReactOS, Solaris and
Windows.

Guest Additions are available:

emulators/virtualbox-ose-additions

For the Extension Pack: FreeBSD is not a supported host platform.
Installation of the Pack will not extend the feature set.

WWW: https://www.virtualbox.org/