From e417298237c935382cf3b7f82edfb4e5d619b11d Mon Sep 17 00:00:00 2001 From: Sebastian Lackner Date: Fri, 3 Apr 2015 00:59:09 +0200 Subject: [PATCH] README.md: Various improvements to the readme file. --- README.md | 32 ++++++++++++++++++++------------ debian/tools/README.md.in | 21 +++++++++++---------- debian/tools/patchupdate.py | 11 +++++++++-- 3 files changed, 40 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 856eb27c..facdd855 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,26 @@ What is Wine Staging? -===================== +--------------------- **Warning: Do not report bugs at bugs.winehq.org when using this version! Please take a look [here](http://bugs.wine-staging.com) for more information about how to report bugs.** **Wine Staging** (formerly wine-compholio) is a special wine version containing -bug fixes and features that are not yet available in regular wine versions. The -idea behind Wine Staging is to provide new features faster to end users and to +bug fixes and features, which are not yet available in regular wine versions. +The idea of Wine Staging is to provide new features faster to end users and to give developers the possibility to discuss and improve their patches before they are sent upstream. We also intend to create a community of wine developers to share experience and to make it easier for beginners to start hacking on -wine. +wine. More information about Wine Staging can also be found on our website +[wine-staging.com](http://wine-staging.com). -Although we are reviewing all patches before adding them, you may encounter -additional bugs, which are not present in regular wine. Make sure to report -such issues in our bug tracker instead of winehq.org so that we can try to -solve them in future versions. Thanks! +Although we are reviewing and testing all patches before adding them, you may +encounter additional bugs, which are not present in vanilla wine. Make sure to +report such issues in our bug tracker instead of winehq.org so that we can try +to solve them in future versions. Thanks! How to install and use Wine Staging -=================================== +----------------------------------- Ready-to-use packages for Wine Staging are available for a variety of different Linux distributions directly for download. Just follow the @@ -36,9 +37,9 @@ Wine. All those differences are also documented on the Included bug fixes and improvements -=================================== +----------------------------------- -**Bugfixes and features included in the next upcoming release [15]:** +**Bug fixes and features included in the next upcoming release [15]:** * Add stub fltmgr.sys (filter manager driver) ([Wine Bug #23583](https://bugs.winehq.org/show_bug.cgi?id=23583)) * Add stubs for Power[Set|Clear]Request @@ -57,7 +58,14 @@ Included bug fixes and improvements * Support for linux priority levels for faster performance -**Bugs fixed in Wine Staging 1.7.39 [205]:** +**Bug fixes and features in Wine Staging 1.7.39 [205]:** + +*Note: The following list only contains features and bug fixes which are not +yet available in vanilla Wine. They are removed from the list as soon as they +are included upstream. The list also includes features and fixes from previous +releases, take a look at the +[changelog](https://github.com/wine-compholio/wine-staging/blob/master/debian/changelog) +for more details.* * Add Dynamic DST exceptions for Israel Standard Time ([Wine Bug #36374](https://bugs.winehq.org/show_bug.cgi?id=36374)) * Add default ACLs for user shell folders diff --git a/debian/tools/README.md.in b/debian/tools/README.md.in index 1215e2e0..bf93485c 100644 --- a/debian/tools/README.md.in +++ b/debian/tools/README.md.in @@ -1,25 +1,26 @@ What is Wine Staging? -===================== +--------------------- **Warning: Do not report bugs at bugs.winehq.org when using this version! Please take a look [here](http://bugs.wine-staging.com) for more information about how to report bugs.** **Wine Staging** (formerly wine-compholio) is a special wine version containing -bug fixes and features that are not yet available in regular wine versions. The -idea behind Wine Staging is to provide new features faster to end users and to +bug fixes and features, which are not yet available in regular wine versions. +The idea of Wine Staging is to provide new features faster to end users and to give developers the possibility to discuss and improve their patches before they are sent upstream. We also intend to create a community of wine developers to share experience and to make it easier for beginners to start hacking on -wine. +wine. More information about Wine Staging can also be found on our website +[wine-staging.com](http://wine-staging.com). -Although we are reviewing all patches before adding them, you may encounter -additional bugs, which are not present in regular wine. Make sure to report -such issues in our bug tracker instead of winehq.org so that we can try to -solve them in future versions. Thanks! +Although we are reviewing and testing all patches before adding them, you may +encounter additional bugs, which are not present in vanilla wine. Make sure to +report such issues in our bug tracker instead of winehq.org so that we can try +to solve them in future versions. Thanks! How to install and use Wine Staging -=================================== +----------------------------------- Ready-to-use packages for Wine Staging are available for a variety of different Linux distributions directly for download. Just follow the @@ -36,7 +37,7 @@ Wine. All those differences are also documented on the Included bug fixes and improvements -=================================== +----------------------------------- {fixes} diff --git a/debian/tools/patchupdate.py b/debian/tools/patchupdate.py index 3fc93b6f..7ec4169d 100755 --- a/debian/tools/patchupdate.py +++ b/debian/tools/patchupdate.py @@ -699,13 +699,20 @@ def generate_markdown(all_patches, stable_patches, stable_compholio_version): # Generate information for current version lines = [] if len(new_fixes): - lines.append("**Bugfixes and features included in the next upcoming release [%d]:**" % len(new_fixes)) + lines.append("**Bug fixes and features included in the next upcoming release [%d]:**" % len(new_fixes)) lines.append("") for mode, bugid, bugname in sorted(new_fixes, key=lambda x: x[2]): lines.append(_format_bug(mode, bugid, bugname)) lines.append("") lines.append("") - lines.append("**Bugs fixed in Wine Staging %s [%d]:**" % (stable_compholio_version, len(old_fixes))) + lines.append("**Bug fixes and features in Wine Staging %s [%d]:**" % (stable_compholio_version, len(old_fixes))) + lines.append("") + lines.append("*Note: The following list only contains features and bug fixes which are not") + lines.append("yet available in vanilla Wine. They are removed from the list as soon as they") + lines.append("are included upstream. The list also includes features and fixes from previous") + lines.append("releases, take a look at the") + lines.append("[changelog](https://github.com/wine-compholio/wine-staging/blob/master/debian/changelog)") + lines.append("for more details.*") lines.append("") for mode, bugid, bugname in sorted(old_fixes, key=lambda x: x[2]): lines.append(_format_bug(mode, bugid, bugname))