Changeset 4208 for lm-sensors/trunk/lib/libsensors.3

Timestamp:

10/13/06 21:55:41 (7 years ago)

Author:

khali

Message:

libsensors: Drop support for algorithm names.
I2C algorithms no longer have names in Linux 2.6, and anyway they are
implementation details user-space doesn't care about. No third party
application is known to have ever used this particular feature of
libsensors. "sensord" and "sensors" no longer do.

Files:

• lm-sensors/trunk/lib/libsensors.3 (modified) (3 diffs)

lm-sensors/trunk/lib/libsensors.3

@@ -25 +25 @@
 .\" References consulted:
 .\"     libsensors source code
-.TH libsensors 3  "December 30, 1998" "" "Linux Programmer's Manual"
+.TH libsensors 3  "October 2006" "" "Linux Programmer's Manual"
 .SH NAME
-libsensors \- publically accessible functions provided by the sensors library
+libsensors \- publicly accessible functions provided by the sensors library
 .SH SYNOPSIS
 .nf
@@ -40 +40 @@
 .B int sensors_chip_name_has_wildcards(sensors_chip_name chip);
 .B const char *sensors_get_adapter_name(int bus_nr);
-.B const char *sensors_get_algorithm_name(int bus_nr);
 .B int sensors_get_label(sensors_chip_name name, int feature, 
                       \fBchar **result);\fP
@@ -80 +79 @@
 .B const char *sensors_get_adapter_name(int bus_nr);
 .br
+This function returns the adapter name of a bus number, as used within the
+sensors_chip_name structure. If it could not be found, it returns NULL.
+
 .B const char *sensors_get_algorithm_name(int bus_nr);
 .br
-These functions return the adapter and algorithm names of a bus number, as used within the sensors_chip_name structure. If it could not be found, it returns NULL
+This function used to return the algorithm name of a bus number.
+It is now deprecated and returns an arbitrary string. It will be dropped
+in a later version of the library so you should stop using it.
 
 \fBint sensors_get_label(sensors_chip_name name, int feature,