Skip to content

Commit

Permalink
Update the README, NEWS and PLATFORMS files.
Browse files Browse the repository at this point in the history
Remove $Id$, since it's no longer expanded.
  • Loading branch information
tdb committed Aug 2, 2013
1 parent 456d2de commit 5f01fdd
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 87 deletions.
22 changes: 12 additions & 10 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
libstatgrab NEWS
http://www.i-scream.org/libstatgrab/

$Id$

PLANS: We're now working towards a 1.0 release which is where we plan
to stabilise the API. We'll be doing test releases before hand,
but as always we'll like to hear about any bugs found in the
current release.

libstatgrab 0.90
* thread safety and reentrant functions
* API unification (every stats call is enabled returning multiple entries)
* complete rewrite of internal memory management (ease future extensions)
* add experimental support for tracing using log4cplus
* complete ports for AIX, HP-UX and nearly every widely common BSD
* complete port for Darwin/MacOS X including basic Mach
* clean up FreeBSD and SOlaris implementation
* remove explicit Linux 2.4 support
* Please note the API in 0.90 has changed, so applications using
libstatgrab will need to be updated to support the changes.

* Thread safety and reentrant functions.
* API unification (every stats call is now able to return multiple entries).
* Complete rewrite of internal memory management (eases future extensions).
* Add experimental support for tracing using log4cplus.
* Complete the ports for AIX, HP-UX and most of the widely used
BSD-based operating systems.
* Complete the port for Darwin/MacOS X including basic Mach.
* Clean up the FreeBSD and Solaris implementations.
* Remove explicit support for Linux 2.4.

libstatgrab 0.17 (21 February 2010)
* Provide iowait cpu information on Linux version 2.5.41 or later.
Expand Down
77 changes: 14 additions & 63 deletions PLATFORMS
Original file line number Diff line number Diff line change
@@ -1,35 +1,26 @@
libstatgrab PLATFORMS
http://www.i-scream.org/libstatgrab/

$Id$

Supported Platforms
===================

libstatgrab-0.18 has been tested to work on the following platforms:
libstatgrab-0.90 has been tested to work on the following platforms:

# Cygwin ?.?
# DragonFly BSD 1.x
# FreeBSD 4.x
# FreeBSD 5.x
FreeBSD 7-STABLE
FreeBSD 8-STABLE
FreeBSD 9-CURRENT
DragonFly BSD 3.4
FreeBSD 7
FreeBSD 8 (i386, amd64)
FreeBSD 9 (i386, amd64, sparc64, ia64)
FreeBSD 10-CURRENT (i386, amd64, sparc64, ia64)
HP-UX 11.11 (parisc)
HP-UX 11.23 (parisc)
HP-UX 11.23 (ia64)
HP-UX 11.31 (ia64)
# Linux 2.2
# Linux 2.4
Linux 2.6 (Ubuntu 10.04, SLES 9-11)
# NetBSD 1.x
# NetBSD 2.x
Linux 2.6 (Ubuntu 10.04, SLES 9-11, Redhat 6, CentOS 6)
Linux 3.X (Ubuntu 12.04)
NetBSD 5.1
NetBSD 5-CURRENT
# OpenBSD 3.x
OpenBSD 4.9-RELASE
# Solaris 6
# Solaris 7
NetBSD 6.1
OpenBSD 4.9
OpenBSD 5.3
Solaris 8 (sparc & x86)
Solaris 9 (sparc & x86)
Solaris 10 (sparc & x86)
Expand All @@ -46,49 +37,9 @@ any of the platforms above without any elevated privileges.
Linux
-----

On Linux root privileges are required to get the statistics returned
by the get_network_iface_stats function. Not having these privileges
results in NULL being returned.
On older Linux kernels root privileges are required to get the
statistics returned by the get_network_iface_stats function. Not
having these privileges results in NULL being returned.

Also note that this cannot be solved by calling sg_init and then
sg_drop_privileges at this stage.

FreeBSD 4
---------

On FreeBSD 4 (not on 5) programs need to be setgid kmem to get swap
statistics. It is sufficient to give a program these privileges, call
sg_init, and then drop the privileges using sg_drop_privileges.

The sg_get_swap_stats function will return NULL if this hasn't been done.

Solaris 2.6/2.7
---------------

On Solaris 2.6 and 2.7 root privileges are required to build the drive
mapping list (eg. mapping ssd0 on to c0t0d0s0). If these privileges
aren't available the names will be left as ssd0, for example.

It is sufficient to use sg_init and sg_drop_privileges.

Cygwin
------

Full support for libstatgrab isn't yet provided on cygwin - there are
some stats which we just can't get. In these cases the functions will
return NULL to indicate failure.

If you have installed libncurses-devel but the configure script can't
find ncurses.h, you've most likely hit a bug in the cygwin package. To
fix this run: /etc/postinstall/libncurses-devel.sh.done

HP-UX
-----

To get large file support (eg. to grab statistics for huge file systems),
set the C Compiler flags to enable _LARGEFILE64_SOURCE (eg.
CFLAGS="-D_LARGEFILE64_SOURCE ..." ./configure ...)

AIX
---

17 changes: 7 additions & 10 deletions README
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
libstatgrab README
http://www.i-scream.org/libstatgrab/

$Id$

Description
-----------

Expand Down Expand Up @@ -44,19 +42,18 @@ sections "Optional Features" and "Optional Packages" of the output of
Prerequisites
-------------

While libstatgrab will run without additional prerequisites, there're
While libstatgrab will run without additional prerequisites, there are
several options to improve it.

* Having a current 1.1.0 developer version of log4cplus will enable
tracing functionalities
See how getting log4cplus on it's project homepage at
* Having a recent (1.1.0+) version of log4cplus will enable tracing
functionalities. log4cplus can be found on its homepage here;
http://log4cplus.sourceforge.net/
Note that libstatgrab doesn't enable it's logging automatically,
Note that libstatgrab doesn't enable its logging automatically,
the using applications must do it.
* Manpages can be built automatically when docbook2x is installed.
See http://docbook2x.sourceforge.net/
* On Linux it might be necessary to install the ncurses-dev package
to get saidar compiled.
* On Linux it might be necessary to install the ncurses-dev (or
equivalent) package to build saidar.

Platform Specific Notes
-----------------------
Expand All @@ -72,4 +69,4 @@ information on how to do that on our website:

http://www.i-scream.org/support.xhtml

Thank-you for using i-scream software.
Thank you for using libstatgrab.
6 changes: 2 additions & 4 deletions README.CVS → README.git
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
libstatgrab CVS README
libstatgrab Git README
http://www.i-scream.org/libstatgrab/

$Id$

Starting from CVS there are a few things that need to be done before
Starting from Git there are a few things that need to be done before
the normal build procedure. These require autoconf, automake, and
libtool to be installed.

Expand Down

0 comments on commit 5f01fdd

Please sign in to comment.