mirror of
https://gitlab.winehq.org/wine/wine-staging.git
synced 2024-09-13 09:17:20 -07:00
Move developer readme (DEVELOPER.md) into a separate file.
This commit is contained in:
Sebastian Lackner
parent
9017db8694
commit
b0daaa4b96
75
DEVELOPER.md
Normal file
75
DEVELOPER.md
Normal file
@ -0,0 +1,75 @@
|
||||
Compiling wine-compholio
|
||||
========================
|
||||
|
||||
**Warning:** Please note that starting with wine-compholio 1.7.23 it is deprecated
|
||||
to manually apply patches without using the Makefile. To avoid typical pitfalls for
|
||||
package maintainers (like trying to use the patch commandline utility for binary patches
|
||||
or not updating the patchlist) it is highly recommended to use the Makefile in order
|
||||
to apply all patches. This ensures that the the correct patch utility is used, that
|
||||
the list of patches is updated appropriately, and so on. Please note that it is still
|
||||
possible to exclude patches if desired, take a look at the end of this document for
|
||||
more details.
|
||||
|
||||
Instructions
|
||||
------------
|
||||
|
||||
The following instructions (based on the
|
||||
[Gentoo Wiki](https://wiki.gentoo.org/wiki/Netflix/Pipelight#Compiling_manually))
|
||||
will give a short overview how to compile wine-compholio, but of course not explain
|
||||
all details. Make sure to install all required Wine dependencies before proceeding.
|
||||
|
||||
As the first step please grab the latest Wine source:
|
||||
```bash
|
||||
wget http://prdownloads.sourceforge.net/wine/wine-1.7.23.tar.bz2
|
||||
wget https://github.com/compholio/wine-compholio-daily/archive/v1.7.23.tar.gz
|
||||
```
|
||||
Extract the archives:
|
||||
```bash
|
||||
tar xvjf wine-1*.tar.bz2
|
||||
cd wine-1*
|
||||
tar xvzf ../v1.7.23.tar.gz --strip-components 1
|
||||
```
|
||||
And apply the patches:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) install
|
||||
```
|
||||
Afterwards run configure (you can also specify a prefix if you don't want to install
|
||||
wine-compholio system-wide):
|
||||
```bash
|
||||
./configure --with-xattr
|
||||
```
|
||||
Before you continue you should make sure that `./configure` doesn't show any warnings
|
||||
(look at the end of the output). If there are any warnings, this most likely means
|
||||
that you're missing some important header files. Install them and repeat the `./configure`
|
||||
step until all problems are fixed.
|
||||
|
||||
Afterwards compile it (and grab a cup of coffee):
|
||||
```bash
|
||||
make
|
||||
```
|
||||
And install it (you only need sudo for a system-wide installation):
|
||||
```bash
|
||||
sudo make install
|
||||
```
|
||||
|
||||
Excluding patches
|
||||
-----------------
|
||||
|
||||
It is also possible to apply only a subset of the patches, for example if you're
|
||||
compiling for a distribution where PulseAudio is not installed, or if you just don't
|
||||
like a specific patchset. Please note that some patchsets depend on each other, and
|
||||
requesting an impossible situation might result in a failure to apply all patches.
|
||||
|
||||
Lets assume you want to exclude the patchset in directory `DIRNAME`, then just invoke the
|
||||
Makefile like this:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) install -W DIRNAME.ok
|
||||
```
|
||||
|
||||
Using the same method its also possible to exclude multiple patchsets. If you want to
|
||||
exclude a very large number of patches, it is easier to do specify a list of patches
|
||||
which should be included instead. To apply for example only the patchsets in directory
|
||||
`DIRNAME1` and `DIRNAME2`, you can use:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) PATCHLIST="DIRNAME1.ok DIRNAME2.ok" install
|
||||
```
|
||||
77
README.md
77
README.md
@ -339,80 +339,3 @@ possible, since this will significantly increase chances to provide support and
|
||||
* Version number (`/opt/wine-compholio/bin/wine --version`)
|
||||
* Patches in your build (`/opt/wine-compholio/bin/wine --patches`)
|
||||
* Installed optional libraries (`/opt/wine-compholio/bin/wine --check-libs`)
|
||||
|
||||
|
||||
Compiling wine-compholio
|
||||
========================
|
||||
|
||||
**Warning:** Please note that starting with wine-compholio 1.7.23 it is deprecated
|
||||
to manually apply patches without using the Makefile. To avoid typical pitfalls for
|
||||
package maintainers (like trying to use the patch commandline utility for binary patches
|
||||
or not updating the patchlist) it is highly recommended to use the Makefile in order
|
||||
to apply all patches. This ensures that the the correct patch utility is used, that
|
||||
the list of patches is updated appropriately, and so on. Please note that it is still
|
||||
possible to exclude patches if desired, take a look at the end of this document for
|
||||
more details.
|
||||
|
||||
Instructions
|
||||
------------
|
||||
|
||||
The following instructions (based on the
|
||||
[Gentoo Wiki](https://wiki.gentoo.org/wiki/Netflix/Pipelight#Compiling_manually))
|
||||
will give a short overview how to compile wine-compholio, but of course not explain
|
||||
all details. Make sure to install all required Wine dependencies before proceeding.
|
||||
|
||||
As the first step please grab the latest Wine source:
|
||||
```bash
|
||||
wget http://prdownloads.sourceforge.net/wine/wine-1.7.23.tar.bz2
|
||||
wget https://github.com/compholio/wine-compholio-daily/archive/v1.7.23.tar.gz
|
||||
```
|
||||
Extract the archives:
|
||||
```bash
|
||||
tar xvjf wine-1*.tar.bz2
|
||||
cd wine-1*
|
||||
tar xvzf ../v1.7.23.tar.gz --strip-components 1
|
||||
```
|
||||
And apply the patches:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) install
|
||||
```
|
||||
Afterwards run configure (you can also specify a prefix if you don't want to install
|
||||
wine-compholio system-wide):
|
||||
```bash
|
||||
./configure --with-xattr
|
||||
```
|
||||
Before you continue you should make sure that `./configure` doesn't show any warnings
|
||||
(look at the end of the output). If there are any warnings, this most likely means
|
||||
that you're missing some important header files. Install them and repeat the `./configure`
|
||||
step until all problems are fixed.
|
||||
|
||||
Afterwards compile it (and grab a cup of coffee):
|
||||
```bash
|
||||
make
|
||||
```
|
||||
And install it (you only need sudo for a system-wide installation):
|
||||
```bash
|
||||
sudo make install
|
||||
```
|
||||
|
||||
Excluding patches
|
||||
-----------------
|
||||
|
||||
It is also possible to apply only a subset of the patches, for example if you're
|
||||
compiling for a distribution where PulseAudio is not installed, or if you just don't
|
||||
like a specific patchset. Please note that some patchsets depend on each other, and
|
||||
requesting an impossible situation might result in a failure to apply all patches.
|
||||
|
||||
Lets assume you want to exclude the patchset in directory `DIRNAME`, then just invoke the
|
||||
Makefile like this:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) install -W DIRNAME.ok
|
||||
```
|
||||
|
||||
Using the same method its also possible to exclude multiple patchsets. If you want to
|
||||
exclude a very large number of patches, it is easier to do specify a list of patches
|
||||
which should be included instead. To apply for example only the patchsets in directory
|
||||
`DIRNAME1` and `DIRNAME2`, you can use:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) PATCHLIST="DIRNAME1.ok DIRNAME2.ok" install
|
||||
```
|
||||
|
||||
75
debian/tools/DEVELOPER.md.in
vendored
Normal file
75
debian/tools/DEVELOPER.md.in
vendored
Normal file
@ -0,0 +1,75 @@
|
||||
Compiling wine-compholio
|
||||
========================
|
||||
|
||||
**Warning:** Please note that starting with wine-compholio 1.7.23 it is deprecated
|
||||
to manually apply patches without using the Makefile. To avoid typical pitfalls for
|
||||
package maintainers (like trying to use the patch commandline utility for binary patches
|
||||
or not updating the patchlist) it is highly recommended to use the Makefile in order
|
||||
to apply all patches. This ensures that the the correct patch utility is used, that
|
||||
the list of patches is updated appropriately, and so on. Please note that it is still
|
||||
possible to exclude patches if desired, take a look at the end of this document for
|
||||
more details.
|
||||
|
||||
Instructions
|
||||
------------
|
||||
|
||||
The following instructions (based on the
|
||||
[Gentoo Wiki](https://wiki.gentoo.org/wiki/Netflix/Pipelight#Compiling_manually))
|
||||
will give a short overview how to compile wine-compholio, but of course not explain
|
||||
all details. Make sure to install all required Wine dependencies before proceeding.
|
||||
|
||||
As the first step please grab the latest Wine source:
|
||||
```bash
|
||||
wget http://prdownloads.sourceforge.net/wine/wine-{version}.tar.bz2
|
||||
wget https://github.com/compholio/wine-compholio-daily/archive/v{version}.tar.gz
|
||||
```
|
||||
Extract the archives:
|
||||
```bash
|
||||
tar xvjf wine-1*.tar.bz2
|
||||
cd wine-1*
|
||||
tar xvzf ../v{version}.tar.gz --strip-components 1
|
||||
```
|
||||
And apply the patches:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) install
|
||||
```
|
||||
Afterwards run configure (you can also specify a prefix if you don't want to install
|
||||
wine-compholio system-wide):
|
||||
```bash
|
||||
./configure --with-xattr
|
||||
```
|
||||
Before you continue you should make sure that `./configure` doesn't show any warnings
|
||||
(look at the end of the output). If there are any warnings, this most likely means
|
||||
that you're missing some important header files. Install them and repeat the `./configure`
|
||||
step until all problems are fixed.
|
||||
|
||||
Afterwards compile it (and grab a cup of coffee):
|
||||
```bash
|
||||
make
|
||||
```
|
||||
And install it (you only need sudo for a system-wide installation):
|
||||
```bash
|
||||
sudo make install
|
||||
```
|
||||
|
||||
Excluding patches
|
||||
-----------------
|
||||
|
||||
It is also possible to apply only a subset of the patches, for example if you're
|
||||
compiling for a distribution where PulseAudio is not installed, or if you just don't
|
||||
like a specific patchset. Please note that some patchsets depend on each other, and
|
||||
requesting an impossible situation might result in a failure to apply all patches.
|
||||
|
||||
Lets assume you want to exclude the patchset in directory `DIRNAME`, then just invoke the
|
||||
Makefile like this:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) install -W DIRNAME.ok
|
||||
```
|
||||
|
||||
Using the same method its also possible to exclude multiple patchsets. If you want to
|
||||
exclude a very large number of patches, it is easier to do specify a list of patches
|
||||
which should be included instead. To apply for example only the patchsets in directory
|
||||
`DIRNAME1` and `DIRNAME2`, you can use:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) PATCHLIST="DIRNAME1.ok DIRNAME2.ok" install
|
||||
```
|
||||
77
debian/tools/README.md.in
vendored
77
debian/tools/README.md.in
vendored
@ -307,80 +307,3 @@ possible, since this will significantly increase chances to provide support and
|
||||
* Version number (`/opt/wine-compholio/bin/wine --version`)
|
||||
* Patches in your build (`/opt/wine-compholio/bin/wine --patches`)
|
||||
* Installed optional libraries (`/opt/wine-compholio/bin/wine --check-libs`)
|
||||
|
||||
|
||||
Compiling wine-compholio
|
||||
========================
|
||||
|
||||
**Warning:** Please note that starting with wine-compholio 1.7.23 it is deprecated
|
||||
to manually apply patches without using the Makefile. To avoid typical pitfalls for
|
||||
package maintainers (like trying to use the patch commandline utility for binary patches
|
||||
or not updating the patchlist) it is highly recommended to use the Makefile in order
|
||||
to apply all patches. This ensures that the the correct patch utility is used, that
|
||||
the list of patches is updated appropriately, and so on. Please note that it is still
|
||||
possible to exclude patches if desired, take a look at the end of this document for
|
||||
more details.
|
||||
|
||||
Instructions
|
||||
------------
|
||||
|
||||
The following instructions (based on the
|
||||
[Gentoo Wiki](https://wiki.gentoo.org/wiki/Netflix/Pipelight#Compiling_manually))
|
||||
will give a short overview how to compile wine-compholio, but of course not explain
|
||||
all details. Make sure to install all required Wine dependencies before proceeding.
|
||||
|
||||
As the first step please grab the latest Wine source:
|
||||
```bash
|
||||
wget http://prdownloads.sourceforge.net/wine/wine-{version}.tar.bz2
|
||||
wget https://github.com/compholio/wine-compholio-daily/archive/v{version}.tar.gz
|
||||
```
|
||||
Extract the archives:
|
||||
```bash
|
||||
tar xvjf wine-1*.tar.bz2
|
||||
cd wine-1*
|
||||
tar xvzf ../v{version}.tar.gz --strip-components 1
|
||||
```
|
||||
And apply the patches:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) install
|
||||
```
|
||||
Afterwards run configure (you can also specify a prefix if you don't want to install
|
||||
wine-compholio system-wide):
|
||||
```bash
|
||||
./configure --with-xattr
|
||||
```
|
||||
Before you continue you should make sure that `./configure` doesn't show any warnings
|
||||
(look at the end of the output). If there are any warnings, this most likely means
|
||||
that you're missing some important header files. Install them and repeat the `./configure`
|
||||
step until all problems are fixed.
|
||||
|
||||
Afterwards compile it (and grab a cup of coffee):
|
||||
```bash
|
||||
make
|
||||
```
|
||||
And install it (you only need sudo for a system-wide installation):
|
||||
```bash
|
||||
sudo make install
|
||||
```
|
||||
|
||||
Excluding patches
|
||||
-----------------
|
||||
|
||||
It is also possible to apply only a subset of the patches, for example if you're
|
||||
compiling for a distribution where PulseAudio is not installed, or if you just don't
|
||||
like a specific patchset. Please note that some patchsets depend on each other, and
|
||||
requesting an impossible situation might result in a failure to apply all patches.
|
||||
|
||||
Lets assume you want to exclude the patchset in directory `DIRNAME`, then just invoke the
|
||||
Makefile like this:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) install -W DIRNAME.ok
|
||||
```
|
||||
|
||||
Using the same method its also possible to exclude multiple patchsets. If you want to
|
||||
exclude a very large number of patches, it is easier to do specify a list of patches
|
||||
which should be included instead. To apply for example only the patchsets in directory
|
||||
`DIRNAME1` and `DIRNAME2`, you can use:
|
||||
```bash
|
||||
make -C ./patches DESTDIR=$(pwd) PATCHLIST="DIRNAME1.ok DIRNAME2.ok" install
|
||||
```
|
||||
|
||||
21
debian/tools/patchupdate.py
vendored
21
debian/tools/patchupdate.py
vendored
@ -52,6 +52,9 @@ class config(object):
|
||||
path_README_md = "./README.md"
|
||||
path_template_README_md = "./debian/tools/README.md.in"
|
||||
|
||||
path_DEVELOPER_md = "./DEVELOPER.md"
|
||||
path_template_DEVELOPER_md = "./debian/tools/DEVELOPER.md.in"
|
||||
|
||||
class PatchUpdaterError(RuntimeError):
|
||||
"""Failed to update patches."""
|
||||
pass
|
||||
@ -455,7 +458,7 @@ def generate_makefile(all_patches, fp):
|
||||
fp.write("\ttouch %s.ok\n" % patch.name)
|
||||
fp.write("\n");
|
||||
|
||||
def generate_readme(all_patches, fp):
|
||||
def generate_readme_md(all_patches, fp):
|
||||
"""Generate README.md including information about specific patches and bugfixes."""
|
||||
|
||||
# Get list of all bugs
|
||||
@ -483,6 +486,12 @@ def generate_readme(all_patches, fp):
|
||||
def _enum(x):
|
||||
return "* " + "\n* ".join(x)
|
||||
|
||||
with open(config.path_template_README_md) as template_fp:
|
||||
template = template_fp.read()
|
||||
fp.write(template.format(bugs=_enum(_all_bugs()), fixes=_enum(_all_fixes())))
|
||||
|
||||
def generate_developer_md(fp):
|
||||
|
||||
# Read information from changelog
|
||||
def _read_changelog():
|
||||
with open(config.path_changelog) as fp:
|
||||
@ -496,9 +505,10 @@ def generate_readme(all_patches, fp):
|
||||
if distro.lower() != "unreleased":
|
||||
return version
|
||||
|
||||
with open(config.path_template_README_md) as template_fp:
|
||||
with open(config.path_template_DEVELOPER_md) as template_fp:
|
||||
template = template_fp.read()
|
||||
fp.write(template.format(bugs=_enum(_all_bugs()), fixes=_enum(_all_fixes()), version=_latest_stable_version()))
|
||||
fp.write(template.format(version=_latest_stable_version()))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
@ -521,4 +531,7 @@ if __name__ == "__main__":
|
||||
generate_makefile(all_patches, fp)
|
||||
|
||||
with open(config.path_README_md, "w") as fp:
|
||||
generate_readme(all_patches, fp)
|
||||
generate_readme_md(all_patches, fp)
|
||||
|
||||
with open(config.path_DEVELOPER_md, "w") as fp:
|
||||
generate_developer_md(fp)
|
||||
@ -7,7 +7,7 @@ git diff --cached --name-status | while read status file; do
|
||||
echo "*** UPDATING AUTOGENERATED FILES ***"
|
||||
echo ""
|
||||
debian/tools/patchupdate.py || exit 1
|
||||
git add patches/Makefile README.md || exit 1
|
||||
git add patches/Makefile README.md DEVELOPER.md || exit 1
|
||||
break;
|
||||
fi
|
||||
done
|
||||
|
||||
Loading…
Reference in New Issue
Block a user