Re: [Mesa-dev] [PATCH] docs: try to improve the Meson documentation
Eric Engestrom writes: > On 2019-03-08 at 03:42, Brian Paul wrote: >> Add new Introduction and Advanced Usage sections. >> Spell out a few more details, like "ninja install". >> Improve the layout around example commands. >> Fix grammatical errors and tighten up the text. >> Explain the --prefix option. > > Thanks! I left a couple comments below, but this is: > Reviewed-by: Eric Engestrom > >> --- >> docs/contents.html | 2 +- >> docs/meson.html| 138 >> +++-- >> 2 files changed, 104 insertions(+), 36 deletions(-) >> >> diff --git a/docs/contents.html b/docs/contents.html >> index 6364776..619ac3d 100644 >> --- a/docs/contents.html >> +++ b/docs/contents.html >> @@ -42,8 +42,8 @@ >> Downloading / Unpacking >> Compiling / Installing >> >> -Autoconf >> Meson >> +Autoconf >> (deprecated) >> >> >> Precompiled Libraries >> diff --git a/docs/meson.html b/docs/meson.html >> index f21479c..f9ae669 100644 >> --- a/docs/meson.html >> +++ b/docs/meson.html >> @@ -17,65 +17,98 @@ >> Compilation and Installation using Meson >> >> >> + Introduction >>Basic Usage >> + Advanced Usage >>Cross-compilation and 32-bit >> builds >> >> >> -1. Basic Usage >> +1. Introduction >> >> -The Meson build system is generally considered stable and ready >> -for production >> +For general information about Meson see the >> +http://mesonbuild.com/;>Meson website. >> >> -The meson build is tested on Linux, macOS, Cygwin and Haiku, >> FreeBSD, >> +Mesa's Meson build system is generally considered stable >> and ready >> +for production. >> + >> +The Meson build of Mesa is tested on Linux, macOS, Cygwin and >> Haiku, FreeBSD, >> DragonflyBSD, NetBSD, and should work on OpenBSD. >> >> +If Meson is not already installed on your system, you can typically >> +install it with your package installer. For example: >> + >> +sudo apt-get install meson # Ubuntu >> + >> +or >> + >> +sudo dnf install meson # Fedora >> + >> + >> Mesa requires Meson >= 0.45.0 to build. >> >> Some older versions of meson do not check that they are too old and will >> error >> out in odd ways. >> >> >> +You'll also need https://ninja-build.org/;>Ninja. >> +If it's not already installed, use apt-get or dnf to install >> +the ninja-build package. >> + >> + >> +2. Basic Usage >> + >> >> The meson program is used to configure the source directory and >> generates >> either a ninja build file or Visual Studio® build files. The latter >> must >> -be enabled via the --backend switch, as ninja is the >> default backend on all >> -operating systems. Meson only supports out-of-tree builds, and must be >> passed a >> +be enabled via the --backend switch, as ninja is the >> default >> +backend on all >> +operating systems. >> + >> + >> + >> +Meson only supports out-of-tree builds, and must be passed a >> directory to put built and generated sources into. We'll call that >> directory >> -"build" for examples. >> +"build" here. >> >> >> +Basic configuration is done with: >> + >> >> -meson build/ >> +meson build/ >> >> >> >> -To see a description of your options you can run meson >> configure >> -along with a build directory to view the selected options for. This will >> show >> -your meson global arguments and project arguments, along with their defaults >> -and your local settings. >> +This will create the build directory. >> +If any dependencies are missing, you can install them, or try to remove >> +the dependency with a Meson configuration option (see below). >> + >> + >> + >> +To review the options which Meson chose, run: >> >> + >> +meson configure build/ >> + >> >> >> -Meson does not currently support listing options before configure a build >> -directory, but this feature is being discussed upstream. >> +Meson does not currently support listing configuration options before >> +running "meson build/" but this feature is being discussed upstream. >> For now, we have a bin/meson-options.py script that prints >> the options for you. >> If that script doesn't work for some reason, you can always look in the >> meson_options.txt file at the root of the project. >> >> >> - >> -meson configure build/ >> - >> - >> >> -With additional arguments meson configure is used to change >> -options on already configured build directory. All options passed to this >> -command are in the form -D "command"="value". >> +With additional arguments meson configure can be used to change >> +options for a previously configured build directory. >> +All options passed to this command are in the form >> +-D "command"="value". > > I know you didn't write this bit, but can I suggest s/command/option/ ? > >> +For example: >> >> >> >> -meson configure build/ -Dprefix=/tmp/install -Dglx=true >> +meson configure build/ -Dprefix=/tmp/install -Dglx=true >> >> >> >> @@ -88,33 +121,68 @@ and brackets to represent an empty list
Re: [Mesa-dev] [PATCH] docs: try to improve the Meson documentation
On Thu, Mar 7, 2019 at 11:51 PM Eric Engestrom wrote: > On 2019-03-08 at 03:42, Brian Paul wrote: > > Add new Introduction and Advanced Usage sections. > > Spell out a few more details, like "ninja install". > > Improve the layout around example commands. > > Fix grammatical errors and tighten up the text. > > Explain the --prefix option. > > Thanks! I left a couple comments below, but this is: > Reviewed-by: Eric Engestrom > > > --- > > docs/contents.html | 2 +- > > docs/meson.html| 138 > +++-- > > 2 files changed, 104 insertions(+), 36 deletions(-) > > > > diff --git a/docs/contents.html b/docs/contents.html > > index 6364776..619ac3d 100644 > > --- a/docs/contents.html > > +++ b/docs/contents.html > > @@ -42,8 +42,8 @@ > > Downloading / Unpacking > > Compiling / Installing > > > > -Autoconf > > Meson > > +Autoconf > (deprecated) > > > > > > Precompiled > Libraries > > diff --git a/docs/meson.html b/docs/meson.html > > index f21479c..f9ae669 100644 > > --- a/docs/meson.html > > +++ b/docs/meson.html > > @@ -17,65 +17,98 @@ > > Compilation and Installation using Meson > > > > > > + Introduction > >Basic Usage > > + Advanced Usage > >Cross-compilation and 32-bit > builds > > > > > > -1. Basic Usage > > +1. Introduction > > > > -The Meson build system is generally considered stable and > ready > > -for production > > +For general information about Meson see the > > +http://mesonbuild.com/;>Meson website. > > > > -The meson build is tested on Linux, macOS, Cygwin and Haiku, > > FreeBSD, > > +Mesa's Meson build system is generally considered stable > > and ready > > +for production. > > + > > +The Meson build of Mesa is tested on Linux, macOS, Cygwin and > > Haiku, FreeBSD, > > DragonflyBSD, NetBSD, and should work on OpenBSD. > > > > +If Meson is not already installed on your system, you can typically > > +install it with your package installer. For example: > > + > > +sudo apt-get install meson # Ubuntu > > + > > +or > > + > > +sudo dnf install meson # Fedora > > + > > + > > Mesa requires Meson >= 0.45.0 to build. > > > > Some older versions of meson do not check that they are too old and > will error > > out in odd ways. > > > > > > +You'll also need https://ninja-build.org/;>Ninja. > > +If it's not already installed, use apt-get or dnf to install > > +the ninja-build package. > > + > > + > > +2. Basic Usage > > + > > > > The meson program is used to configure the source directory and > > generates > > either a ninja build file or Visual Studio® build files. The latter > > must > > -be enabled via the --backend switch, as ninja is the > > default backend on all > > -operating systems. Meson only supports out-of-tree builds, and must be > > passed a > > +be enabled via the --backend switch, as ninja is the > > default > > +backend on all > > +operating systems. > > + > > + > > + > > +Meson only supports out-of-tree builds, and must be passed a > > directory to put built and generated sources into. We'll call that > > directory > > -"build" for examples. > > +"build" here. > > > > > > +Basic configuration is done with: > > + > > > > -meson build/ > > +meson build/ > > > > > > > > -To see a description of your options you can run meson > configure > > -along with a build directory to view the selected options for. This > will show > > -your meson global arguments and project arguments, along with their > defaults > > -and your local settings. > > +This will create the build directory. > > +If any dependencies are missing, you can install them, or try to remove > > +the dependency with a Meson configuration option (see below). > > + > > + > > + > > +To review the options which Meson chose, run: > > > > + > > +meson configure build/ > > + > > > > > > -Meson does not currently support listing options before configure a > build > > -directory, but this feature is being discussed upstream. > > +Meson does not currently support listing configuration options before > > +running "meson build/" but this feature is being discussed upstream. > > For now, we have a bin/meson-options.py script that prints > > the options for you. > > If that script doesn't work for some reason, you can always look in the > > meson_options.txt file at the root of the project. > > > > > > - > > -meson configure build/ > > - > > - > > > > -With additional arguments meson configure is used to change > > -options on already configured build directory. All options passed to > this > > -command are in the form -D "command"="value". > > +With additional arguments meson configure can be used to > change > > +options for a previously configured build directory. > > +All options passed to this command are in the form > > +-D "command"="value". > > I know you didn't write this bit, but can I suggest s/command/option/ ? > Done. > > +For example: > > > > > > > > -meson configure build/
Re: [Mesa-dev] [PATCH] docs: try to improve the Meson documentation
On 2019-03-08 at 03:42, Brian Paul wrote: > Add new Introduction and Advanced Usage sections. > Spell out a few more details, like "ninja install". > Improve the layout around example commands. > Fix grammatical errors and tighten up the text. > Explain the --prefix option. Thanks! I left a couple comments below, but this is: Reviewed-by: Eric Engestrom > --- > docs/contents.html | 2 +- > docs/meson.html| 138 > +++-- > 2 files changed, 104 insertions(+), 36 deletions(-) > > diff --git a/docs/contents.html b/docs/contents.html > index 6364776..619ac3d 100644 > --- a/docs/contents.html > +++ b/docs/contents.html > @@ -42,8 +42,8 @@ > Downloading / Unpacking > Compiling / Installing > > -Autoconf > Meson > +Autoconf > (deprecated) > > > Precompiled Libraries > diff --git a/docs/meson.html b/docs/meson.html > index f21479c..f9ae669 100644 > --- a/docs/meson.html > +++ b/docs/meson.html > @@ -17,65 +17,98 @@ > Compilation and Installation using Meson > > > + Introduction >Basic Usage > + Advanced Usage >Cross-compilation and 32-bit > builds > > > -1. Basic Usage > +1. Introduction > > -The Meson build system is generally considered stable and ready > -for production > +For general information about Meson see the > +http://mesonbuild.com/;>Meson website. > > -The meson build is tested on Linux, macOS, Cygwin and Haiku, > FreeBSD, > +Mesa's Meson build system is generally considered stable > and ready > +for production. > + > +The Meson build of Mesa is tested on Linux, macOS, Cygwin and > Haiku, FreeBSD, > DragonflyBSD, NetBSD, and should work on OpenBSD. > > +If Meson is not already installed on your system, you can typically > +install it with your package installer. For example: > + > +sudo apt-get install meson # Ubuntu > + > +or > + > +sudo dnf install meson # Fedora > + > + > Mesa requires Meson >= 0.45.0 to build. > > Some older versions of meson do not check that they are too old and will > error > out in odd ways. > > > +You'll also need https://ninja-build.org/;>Ninja. > +If it's not already installed, use apt-get or dnf to install > +the ninja-build package. > + > + > +2. Basic Usage > + > > The meson program is used to configure the source directory and > generates > either a ninja build file or Visual Studio® build files. The latter > must > -be enabled via the --backend switch, as ninja is the > default backend on all > -operating systems. Meson only supports out-of-tree builds, and must be > passed a > +be enabled via the --backend switch, as ninja is the > default > +backend on all > +operating systems. > + > + > + > +Meson only supports out-of-tree builds, and must be passed a > directory to put built and generated sources into. We'll call that > directory > -"build" for examples. > +"build" here. > > > +Basic configuration is done with: > + > > -meson build/ > +meson build/ > > > > -To see a description of your options you can run meson configure > -along with a build directory to view the selected options for. This will show > -your meson global arguments and project arguments, along with their defaults > -and your local settings. > +This will create the build directory. > +If any dependencies are missing, you can install them, or try to remove > +the dependency with a Meson configuration option (see below). > + > + > + > +To review the options which Meson chose, run: > > + > +meson configure build/ > + > > > -Meson does not currently support listing options before configure a build > -directory, but this feature is being discussed upstream. > +Meson does not currently support listing configuration options before > +running "meson build/" but this feature is being discussed upstream. > For now, we have a bin/meson-options.py script that prints > the options for you. > If that script doesn't work for some reason, you can always look in the > meson_options.txt file at the root of the project. > > > - > -meson configure build/ > - > - > > -With additional arguments meson configure is used to change > -options on already configured build directory. All options passed to this > -command are in the form -D "command"="value". > +With additional arguments meson configure can be used to change > +options for a previously configured build directory. > +All options passed to this command are in the form > +-D "command"="value". I know you didn't write this bit, but can I suggest s/command/option/ ? > +For example: > > > > -meson configure build/ -Dprefix=/tmp/install -Dglx=true > +meson configure build/ -Dprefix=/tmp/install -Dglx=true > > > > @@ -88,33 +121,68 @@ and brackets to represent an empty list (-D > platforms=[]). > > > Once you've run the initial meson command successfully you can > use > -your configured backend to build the project. With ninja, the -C option can > be > -be used to point
