Thanks to Aaron Peters for researching and writing this chapter from
scratch. He also provided most of the images, together with Alexander
Leidinger (netchild@). Alexander was also kind enough to be the official
mentor for the WINE side of the content, while I focused on the
documentation side. His insights into WINE from a users perspective
helped make this chapter better by adding information about Homura.
A big thank you to Google Season of Docs 2020 for enabling us to have
Aaron as technical writer working on this project.
I've re-ordered the finalized submission so that the FAQ is the last
part of this chapter. I also moved the "WINE Overview & concepts"
section after the Synopsis for a more logical flow of information.
Additionally, a lot of DocBook editing was done to bring it to the
current form. The remaining checks by textproc/igor revolve around
indentation errors. But one can't fix all of them without violating
others.
Please enjoy running WINE and games on FreeBSD with the help of this
chapter.
Todo:
- Some references to other parts of the chapter or to others in the
handbook need to be replaced by actual links.
- Some of the images could be resized a bit more. I only did it on
those that would create a horizontal scroll bar. Reizing them to 50%
made them small enough to fit the other images while retaining
legible text.
A note on the images: I realize they are mixed JPEG and PNGs in the
same chapter. However, many of the images in the handbook do not
have a uniform image type either (compare IMAGES_EN+= entries in
Makefile). This may be a future project to unify these without
compromising image quality.
Contributed by: Aaron Peters (acpkendo gmail.com)
Reviewed by: netchild, bcr
Sponsored by: Google Season of Docs 2020
Differential Revision: https://reviews.freebsd.org/D27484
Differential Revision: https://reviews.freebsd.org/D27455
Differential Revision: https://reviews.freebsd.org/D27444
Differential Revision: https://reviews.freebsd.org/D27232
Differential Revision: https://reviews.freebsd.org/D27146
Differential Revision: https://reviews.freebsd.org/D26983
Differential Revision: https://reviews.freebsd.org/D26914
Differential Revision: https://reviews.freebsd.org/D26788
Summary:
The doc repository is not mirrored to Subversion so updating the
repository from Subversion does not make sense. Remove
Subversion-specific files too.
While here remove now defunct $FreeBSD$ markers in affected files.
Test Plan:
make clean
make update
make
Reviewed by: bcr, ygy, doceng (gjb)
Differential Revision: https://reviews.freebsd.org/D27678
Subscribers: drewery, emaste
- Add a <githash> tag which accepts a Git hash. Leave
<revnumber> as is for svn revisions. In theory we
could add a new attribute to <revnumber> to say which
VCS to use, but this would require tagging either all
SVN revisions or all Git hashes explicitly which would
be invasive. A new tag going forward seems simpler.
- Revert svnweb.link back to generating svnweb links. This
fixes all the explicit <revnumber>'s referring to SVN src
commits in existing documentation.
- Add a cgit.link which links to a Git commit in cgit.
githash generates cgit.link's when asked to generate a
href.
Reviewed by: gjb, ygy
Differential Revision: https://reviews.freebsd.org/D27703
In the UFS ACLs chapter, there is an example showing ACL-enabled
filesystems using a + sign. However, there is a directory private lited
there that is not having ACLs enabled, but it is not mentioned in the
text below the example. Add it there to avoid confusion.
PR: 251528
Submitted by: panden@gmail.com
Steps 1-4 from the Committer's guide:
- Add entries for Juraj Lutter <otis>
- Add GPG key
And while here, also:
- Fix misindentation
- Remove a stray empty line
Reviewed by: osa (mentor)
Approved by: osa (mentor)
Differential Revision: https://reviews.freebsd.org/D27617
Summary:
Problem
It is not clear what we are telling users to read. Also I need a test
commit for phabricator in a git world.
Solution
Change the text to be more precise.
Differential Revision: https://reviews.freebsd.org/D27596
Problem
The documentation ("doc") repository has been converted to git but
arcanist does not yet understand how to interact with phabricator in
this world.
Solution
- remove the callsign "D" which should be inferable from having one of
the cgit URLs as a remote
- remove "history.immutable" which was a workflow only required for
subversion
Enable Cirrus CI to perform a complete doc tree build test. The
official mirror on GitHub, as well as anyone who pushes the repo to
GitHub can enjoy free CI functionality for all commits and pull
requests.
Reviewed by: lwhsu, bcr
Differential Revision: https://reviews.freebsd.org/D27530
A slight reconfiguration of the SD Card section is necessary, as we now
have GENERICSD images for two architectures. Organize those links by
architecture.
Reviewed by: gjb
The $FreeBSD$ tag is obsolete. Remove it. Note: this is a test commit
to ensure that my instructions work end to end. If we do the rest,
then we should do it in bulk so individuals should hold off doing
similar commits unless changing their key.