[Xfce4-commits] <xfce4-cpufreq-plugin:master> Update NEWS, README and TODO.

Harald Judt noreply at xfce.org
Tue Sep 3 14:02:01 CEST 2013 

Updating branch refs/heads/master
         to f6384d9ff9dab351b63ac741e04aa7c8ac692fae (commit)
       from 3ad70bbee6637fc3baeaa3723ea96e4be80085a2 (commit)

commit f6384d9ff9dab351b63ac741e04aa7c8ac692fae
Author: Harald Judt <h.judt at gmx.at>
Date:   Tue Sep 3 14:01:11 2013 +0200

    Update NEWS, README and TODO.

 NEWS   |   22 ++++++++-
 README |  155 +++++++++++++++++++++++++++++++++++++++++++++++++++++++---------
 TODO   |    9 ++++
 3 files changed, 164 insertions(+), 22 deletions(-)

diff --git a/NEWS b/NEWS
index cfd0ba9..7084aaf 100644
--- a/NEWS
+++ b/NEWS
@@ -1,4 +1,24 @@
-1.0.0 (2011/01/23)
+1.1.0 (2013-09-03)
+------------------
+ * Support the Intel performance state driver
+ * Improve config dialog and make it use shortcut keys
+ * Add a proper "About" dialog
+ * Add min, avg and max frequencies in cpu selection
+ * Add support for selecting a custom font
+ * Support showing icon only (bug #7474)
+ * Improve overview window size and layout
+ * Remove code for showing the frame
+ * Rewrite layout code using >=xfce4-panel-4.9 features
+ * Remove code for deprecated APIs and <xfce4-panel-4.9
+ * Build plugin as a module
+ * Fix showing frequency of wrong CPU core (bug #7179)
+ * Fix reading min frequency from cpufreq sysfs
+ * Support panel 4.9 features (deskbar mode) (bug #8396)
+ * Port plugin to libxfce4ui (bug #8051)
+ * Code clean up and refactoring
+ * Updates and fixes for build system files
+
+1.0.0 (2011-01-23)
 ------------------
  * Fix support for xfce 4.8, fixing bug #6448
  * Linux 2.4 support
diff --git a/README b/README
index 18e5730..d11137f 100644
--- a/README
+++ b/README
@@ -1,32 +1,145 @@
-*********************************************
-***********  xfce4-cpufreq-plugin  **********
-*********************************************
+XFCE4-CPUFREQ-PLUGIN
+==========================================================================
+You can always find up-to-date information at the plugin homepage:
+http://goodies.xfce.org/projects/panel-plugins/xfce4-cpufreq-plugin
 
-xfce4-cpufreq-plugin is a Plugin for the Xfce Panel, which 
-shows CPU Informations
 
-** Retrieving **
+CONTENTS
+==========================================================================
+* ABOUT
+* USAGE
+* REPORTING BUGS
+* REQUIREMENTS AND DEPENDENCIES
+* EASY BUILD INSTRUCTIONS
+* TRANSLATING THE PLUGIN FOR YOUR LANGUAGE
 
-The lastet version of xfce4-cpufreq-plugin can always be obtained from
-http://goodies.xfce.org/projects/panel-plugins/xfce4-cpufreq-plugin. 
-Please check to see if there is a newer version available before 
-reporting bugs.
 
-** Requirements **
+ABOUT
+==========================================================================
+Originally written by Thomas Schreck, this panel plugin shows
+information about the CPU governor and frequencies supported and used
+by your system. At the time of this writing, changing any of these
+settings is not supported by this plugin.
 
-* libxfce4util 4.3.90
-* libxfcegui4 4.3.90
-* libxfce4panel 4.3.90			      
 
-** Building **
+USAGE
+==========================================================================
+From the configuration dialog, which is available by right-clicking on
+the panel widget, select the CPU which you want to monitor in the
+panel. Instead of showing values for a single CPU, you can
+alternatively choose minimum, average or maximum, which might make
+more sense on a multi-core system. If your system is using the Intel
+pstate driver, the current maximum will be chosen by default, as this
+is what other monitoring applications like i7z show as the current
+real performance.
 
-./configure
-make
-make install (as root)
+The remaining options on the configuration dialog let you customize
+the panel widget layout and what data is shown on the panel.
 
-** Usage **
+The overview window can be accessed by left-clicking on the panel
+plugin widget, or from the context menu, similar to the configuration
+dialog. It shows detailed information for every CPU (core).
 
-Using the plugin is quite simple. You select the cpu which you want to monitor in the Xfce Panel. Next thing you could change is the timeout interval how often the informations have to be updated. The default value is 1,0 s.
 
-You can also specify which informations should be displayed in the panel.
+REPORTING BUGS
+==========================================================================
+Before reporting bugs or asking for new features, please update to the
+latest version, consolidate the Xfce bug tracker at
+https://bugzilla.xfce.org and check the TODO file, because your issue
+or request might have been reported already or be in planning. However,
+feel free to add any information not yet mentioned that you find useful.
 
+
+BUILD REQUIREMENTS AND DEPENDENCIES
+==========================================================================
+The build requirements for this plugin match those of XFCE. Note that
+with versions newer than 1.0.0, >=xfce4-panel-4.9 is necessary, and
+the plugin will no longer compile nor work with older versions of the
+panel. All code supporting older panel versions has been removed.
+
+
+EASY BUILD INSTRUCTIONS
+==========================================================================
+If you're interesting in building the plugin yourself, these
+instructions provided here will work for most users. If not, please
+look at the INSTALL file or ask at a forum for your linux distribution
+or try the methods explained on http://www.xfce.org/community. Make
+sure you have installed the needed dependencies (see previous section
+BUILD REQUIREMENTS AND DEPENDENCIES).
+
+For the panel being able to find the plugin, it is important to set
+the proper prefix. The prefix is the place in the filesystem where the
+plugin files gets installed. It has to match the prefix used for
+building the panel. There's nothing the plugin can do about that
+requirement. When you're using the panel provided by the package
+management system of your distribution, then the prefix is in most
+cases /usr, otherwise the default prefix is /usr/local.
+
+If you want to install the current version from git, execute the
+following command in the plugin project directory (make sure you have
+GNU automake installed!):
+
+1a) ./autogen.sh --prefix=/usr
+
+Otherwise, if you've downloaded the tarball from e.g.
+http://archive.xfce.org/, issue the following command:
+
+1b) ./configure --prefix=/usr
+
+If 1a) or 1b) fail, you should receive an error message telling you
+the cause for the failure (e.g. missings libraries). If you're missing
+a dependency you need to install it using the package management
+system of your distribution. Distributions commonly have two versions
+of a software package: One containing the supplementary files needed
+for compiling other packages, and the other one providing the runtime
+libraries etc. While the latter is usually installed, the former often
+is not, so better check this.
+
+Note: To solve distribution-specific problems the most efficient way
+is to ask at a forum for your distribution, not on a general forum.
+
+Then for both cases:
+2) make
+
+If this fails, file a bug on https://bugzilla.xfce.org, or send a mail
+to the xfce mailing list and provide make output.
+
+Finally, and usually as root:
+3) make install
+
+Note: Depending on your prefix, this might overwrite an existing
+version of the plugin.
+
+You can later uninstall the plugin (as root) with
+4) make uninstall
+
+The panel should then recognize the new plugin, if it doesn't try to
+restart it using xfce4-panel -r. If it still doesn't work after that
+try to ask for help somewhere (forums, mailing lists, #xfce on
+IRC). Please do not report such problems on the bug tracker.
+
+
+TRANSLATING THE PLUGIN FOR YOUR LANGUAGE
+==========================================================================
+If you need help getting started with translating the cpufreq plugin
+into your language, please visit https://translations.xfce.org/ and
+absorb the information that is there, especially on the *Help* page!
+There is other useful documentation available on this topic, try this
+wiki page for a start:
+https://wiki.xfce.org/translations/translation_guidance_in_xfce
+
+TRANSLATORS, PLEASE MAKE SURE YOU CHECK YOUR FILE FOR ERRORS BEFORE
+UPLOADING IT! Otherwise, it will break compilation of the plugin. It
+is easy to do this with the following command (where file.po is the po
+file of your language):
+msgfmt -c --check-accelerators=_ -v -o /dev/null <file.po>
+
+If your po file is out of date and doesn't contain all strings that
+appear in the plugin source code, you can use the build system to
+update it for you. See the previous section EASY BUILD INSTRUCTIONS
+for setting up the build system and perform step 1a to clone the
+repository and generate the make files using automake. If this
+succeeds, simply change to the po subdirectory and execute the command
+"make update-po". This will regenerate all po files in the po
+directory and mark changed strings as fuzzy or obsolete, and add new
+strings as untranslated. You can then work on it as usual.
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..60ce100
--- /dev/null
+++ b/TODO
@@ -0,0 +1,9 @@
+Here is a collection of ideas and tasks for future releases.
+
+* Add support for changing frequencies and governors. This can be done
+  using polkit and requires redesigning and rewriting UI code. Better
+  than changing frequencies nowadays would be to allow setting certain
+  governor parameters.
+
+* Add support for upower events (AC <-> battery). Maybe make it
+  possible to define profiles for different power states.

More information about the Xfce4-commits mailing list