[pulseaudio-discuss] [PATCH 0/7][paprefs] preparing for paprefs release

Discussion:

Tanu Kaskinen

2018-07-09 13:44:47 UTC

As I'm preparing to release paprefs 1.0, I went through the README and
found several things that needed updating.

Removing the copyright notice and the Acknowledgements section are
potentially controversial, feel free to send your objections and I'll
reconsider.

Tanu Kaskinen (7):
README: remove the copyright notice
README: add "Bug Reports" and "Contributing Code" sections
README: remove the "Acknowledgements" section
README: add a news item for the upcoming release
README: remove reference to an ancient Debian version
README: clarify the PulseAudio version requirement
README: remove the page footer

doc/README.html.in | 33 +++++++++++++++------------------
1 file changed, 15 insertions(+), 18 deletions(-)

--
2.18.0

Tanu Kaskinen

2018-07-09 13:44:49 UTC

Permalink

---
doc/README.html.in | 9 +++++++++
1 file changed, 9 insertions(+)

diff --git a/doc/README.html.in b/doc/README.html.in
index 15c6e95..4e959bb 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -20,6 +20,8 @@
<li><a href="#installation">Installation</a></li>
<li><a href="#acks">Acknowledgements</a></li>
<li><a href="#download">Download</a></li>
+ <li><a href="#bugs">Bug Reports</a></li>
+ <li><a href="#patches">Contributing Code</a></li>
</ul>

<h2><a name="license">License</a></h2>
@@ -115,6 +117,13 @@ compilation and <tt>make install</tt> (as root) for installation of

<pre>git clone git://anongit.freedesktop.org/pulseaudio/paprefs</pre>

+<h2><a name="bugs">Bug Reports</a></h2>
+
+<p>Bugs can be reported on the freedesktop.org bug tracker: <a href="https://bugs.freedesktop.org/enter_bug.cgi?product=PulseAudio">https://bugs.freedesktop.org/enter_bug.cgi?product=PulseAudio</a>. You need to report your bugs against PulseAudio, because there's no separate product on the bug tracker for paprefs.</p>
+
+<h2><a name="patches">Contributing Code</a></h2>
+
+<p>If you have patches for paprefs, send them to the <a href="https://lists.freedesktop.org/mailman/listinfo/pulseaudio-discuss">PulseAudio mailing list</a> (requires subscription). The best (but not mandatory) way to send patches is with the <tt>git send-email</tt> tool. Here are some <a href="https://www.freedesktop.org/wiki/Software/PulseAudio/HowToUseGitSendEmail/">instructions for git send-email</a>.</p> <hr/> <address class="grey">Lennart Poettering <@PACKAGE_BUGREPORT@>, September 2009</address>

--
2.18.0

Tanu Kaskinen

2018-07-09 13:44:48 UTC

Permalink

The copyright notice would need updating, because there are also others
than Lennart who own copyrights to paprefs, and the years are out of
date. Having to continuously update the copyright years seems just
unnecessary churn to me. Interested people can browse the git history if
they're interested in the copyright details.
---
doc/README.html.in | 2 --
1 file changed, 2 deletions(-)

diff --git a/doc/README.html.in b/doc/README.html.in
index 1e0c0fb..15c6e95 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -10,8 +10,6 @@
<body>
<h1><a name="top">PulseAudio Preferences @PACKAGE_VERSION@</a></h1>

-<p><i>Copyright 2006-2009 Lennart Poettering <@PACKAGE_BUGREPORT@></i></p>
-
<ul class="toc">
<li><a href="#license">License</a></li>
<li><a href="#news">News</a></li>

--
2.18.0

Tanu Kaskinen

2018-07-09 13:44:50 UTC

Permalink

Acknowledging people's contributions is nice, but I don't like the chore
of keeping the section up to date.
---
doc/README.html.in | 7 -------
1 file changed, 7 deletions(-)

diff --git a/doc/README.html.in b/doc/README.html.in
index 4e959bb..47b1bde 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -18,7 +18,6 @@
<li><a href="#documentation">Documentation</a></li>
<li><a href="#requirements">Requirements</a></li>
<li><a href="#installation">Installation</a></li>
- <li><a href="#acks">Acknowledgements</a></li>
<li><a href="#download">Download</a></li>
<li><a href="#bugs">Bug Reports</a></li>
<li><a href="#patches">Contributing Code</a></li>
@@ -101,12 +100,6 @@ the source tree. After that you should run <tt>make</tt> for
compilation and <tt>make install</tt> (as root) for installation of
<tt>paprefs</tt>.</p>

-<h2><a name="acks">Acknowledgements</a></h2>
-
-<p>Christian Persch for patches.</p>
-
-<p>Colin Guthrie for the RAOP support and other fixes.</p>
-
<h2><a name="download">Download</a></h2>

<p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>

--
2.18.0

Tanu Kaskinen

2018-07-09 13:44:51 UTC

Permalink

---
doc/README.html.in | 3 +++
1 file changed, 3 insertions(+)

diff --git a/doc/README.html.in b/doc/README.html.in
index 47b1bde..cd0c592 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -37,6 +37,9 @@ General Public License for more details.</p>

<h2><a name="news">News</a></h2>

+<div class="news-date">Soon: </div> <p class="news-text"><a
+href="@***@paprefs-1.0.tar.xz">Version 1.0</a> released; replace GConf with GSettings, port from GTK 2 to GTK 3, add support for fixed RTP port, add Croatian translation</p>
+
<div class="news-date">Tue Sep 27 2011: </div> <p class="news-text"><a
href="@***@paprefs-0.9.10.tar.xz">Version 0.9.10</a> released; minor tidyups, should no longer require recompiling with each new PA version.</p>

--
2.18.0

Tanu Kaskinen

2018-07-09 13:44:52 UTC

Permalink

It's of little use to know that the initial version was written on an
August 2006 version of Debian testing.
---
doc/README.html.in | 8 ++------
1 file changed, 2 insertions(+), 6 deletions(-)

diff --git a/doc/README.html.in b/doc/README.html.in
index cd0c592..3c73715 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -80,12 +80,8 @@ sound server.</p>

<h2><a name="requirements">Requirements</a></h2>

-<p>Currently, <tt>paprefs</tt> is tested on Linux only.</p>
-
-<p><tt>paprefs</tt> was developed and tested on Debian GNU/Linux
-"testing" from August 2006, it should work on most other Linux
-distributions (and maybe Unix versions) since it uses GNU autoconf for
-source code configuration.</p>
+<p>Currently, <tt>paprefs</tt> is tested on Linux only. It should work on most
+Linux distributions.</p>

<p><tt>paprefs</tt> requires <a href="http://gtkmm.sf.net/"><tt>gtkmm</tt></a> and <tt>glademmm</tt> installed.</p>

--
2.18.0

Tanu Kaskinen

2018-07-09 13:44:54 UTC

Permalink

Keeping the footer up to date is extra work with little benefit.
---
doc/README.html.in | 2 --
1 file changed, 2 deletions(-)

diff --git a/doc/README.html.in b/doc/README.html.in
index 2c67a62..8fb1421 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -116,8 +116,6 @@ compilation and <tt>make install</tt> (as root) for installation of
<h2><a name="patches">Contributing Code</a></h2>

<p>If you have patches for paprefs, send them to the <a href="https://lists.freedesktop.org/mailman/listinfo/pulseaudio-discuss">PulseAudio mailing list</a> (requires subscription). The best (but not mandatory) way to send patches is with the <tt>git send-email</tt> tool. Here are some <a href="https://www.freedesktop.org/wiki/Software/PulseAudio/HowToUseGitSendEmail/">instructions for git send-email</a>.</p>
-<hr/>
-<address class="grey">Lennart Poettering <@PACKAGE_BUGREPORT@>, September 2009</address>

</body>
</html>

--
2.18.0

Tanu Kaskinen

2018-07-09 13:44:53 UTC

Permalink

It sounded like the only supported PulseAudio version is 12.0 (well,
currently that's true, but the text won't be updated when new PulseAudio
versions are released).
---
doc/README.html.in | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/README.html.in b/doc/README.html.in
index 3c73715..2c67a62 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -86,7 +86,7 @@ Linux distributions.</p>
<p><tt>paprefs</tt> requires <a href="http://gtkmm.sf.net/"><tt>gtkmm</tt></a> and <tt>glademmm</tt> installed.</p>

<p>Obviously <tt>paprefs</tt> requires an installation of <a
-href="http://pulseaudio.org/">PulseAudio</a> (version 12.0). The
+href="http://pulseaudio.org/">PulseAudio</a> (version 12.0 or newer). The
module <tt>module-gsettings</tt> must be loaded in the daemon.</p>

<p>There is an implicit dependency on PackageKit. If you don't install PackageKit the 'Install' buttons in the UI for installing necessary PulseAudio plugins won't work.</p>

--
2.18.0