From 8cb5fea38431374ccd598235aa251c3e3a742621 Mon Sep 17 00:00:00 2001 From: John Safranek Date: Mon, 11 Aug 2014 16:19:11 -0700 Subject: [PATCH] 1. Added a description comment to each C and H file. 2. Updated the FSF address in the comments. --- examples/server/server.c | 3 ++- src/internal.c | 9 ++++++++- src/io.c | 10 +++++++++- src/log.c | 11 ++++++++++- src/memory.c | 8 +++++++- src/port.c | 11 ++++++++++- src/ssh.c | 8 +++++++- wolfssh/error.h | 9 +++++++-- wolfssh/internal.h | 9 ++++++++- wolfssh/log.h | 10 +++++++++- wolfssh/memory.h | 8 +++++++- wolfssh/port.h | 11 ++++++++++- wolfssh/settings.h | 10 +++++++++- wolfssh/ssh.h | 8 +++++++- wolfssh/version.h | 11 ++++++++++- wolfssh/version.h.in | 11 ++++++++++- wolfssh/visibility.h | 10 +++++++++- 17 files changed, 139 insertions(+), 18 deletions(-) diff --git a/examples/server/server.c b/examples/server/server.c index 0ec3180..94c868b 100644 --- a/examples/server/server.c +++ b/examples/server/server.c @@ -16,7 +16,8 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. */ diff --git a/src/internal.c b/src/internal.c index 9ccb7d0..ee2f507 100644 --- a/src/internal.c +++ b/src/internal.c @@ -16,7 +16,14 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The internal module contains the private data and functions. The public + * API calls into this module to do the work of processing the connections. */ diff --git a/src/io.c b/src/io.c index 3e15328..9a3fdd8 100644 --- a/src/io.c +++ b/src/io.c @@ -16,7 +16,15 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The io module provides the default send and receive callbacks used + * by the library to handle network I/O. By default they handle UNIX + * style I/O. */ diff --git a/src/log.c b/src/log.c index c09ca78..1d96365 100644 --- a/src/log.c +++ b/src/log.c @@ -16,9 +16,18 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. */ + +/* + * The log module contains the interface to the logging function. When + * debugging is enabled and turned on, the logger will output to STDOUT. + * A custom logging callback may be installed. + */ + + #ifdef HAVE_CONFIG_H #include #endif diff --git a/src/memory.c b/src/memory.c index 2f3450a..a8d535d 100644 --- a/src/memory.c +++ b/src/memory.c @@ -16,7 +16,13 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The memory module contains the interface to the custom memory handling hooks. */ diff --git a/src/port.c b/src/port.c index a6dce93..af6b913 100644 --- a/src/port.c +++ b/src/port.c @@ -16,7 +16,16 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The port module wraps standard C library functions with macros to + * cover portablility issues when building in environments that rename + * those functions. This module also provides local versions of some + * standard C library functions that are missing on some platforms. */ diff --git a/src/ssh.c b/src/ssh.c index 2a61fbd..e6f7d2f 100644 --- a/src/ssh.c +++ b/src/ssh.c @@ -16,7 +16,13 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The ssh module contains the public API for wolfSSH. */ diff --git a/wolfssh/error.h b/wolfssh/error.h index 99555b7..8cd5122 100644 --- a/wolfssh/error.h +++ b/wolfssh/error.h @@ -16,7 +16,13 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The error header file provides the error codes used in the library. */ @@ -64,7 +70,6 @@ enum WS_IOerrors { }; - #ifdef __cplusplus } #endif diff --git a/wolfssh/internal.h b/wolfssh/internal.h index 9af1ff4..3793f6f 100644 --- a/wolfssh/internal.h +++ b/wolfssh/internal.h @@ -16,7 +16,14 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The internal module contains the private data and functions. The public + * API calls into this module to do the work of processing the connections. */ diff --git a/wolfssh/log.h b/wolfssh/log.h index c8a6ef0..976b7f1 100644 --- a/wolfssh/log.h +++ b/wolfssh/log.h @@ -16,7 +16,15 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The log module contains the interface to the logging function. When + * debugging is enabled and turned on, the logger will output to STDOUT. + * A custom logging callback may be installed. */ diff --git a/wolfssh/memory.h b/wolfssh/memory.h index ba0c3ab..50065a3 100644 --- a/wolfssh/memory.h +++ b/wolfssh/memory.h @@ -16,7 +16,13 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The memory module contains the interface to the custom memory handling hooks. */ diff --git a/wolfssh/port.h b/wolfssh/port.h index 736d97f..43e8f09 100644 --- a/wolfssh/port.h +++ b/wolfssh/port.h @@ -16,7 +16,16 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The port module wraps standard C library functions with macros to + * cover portablility issues when building in environments that rename + * those functions. This module also provides local versions of some + * standard C library functions that are missing on some platforms. */ diff --git a/wolfssh/settings.h b/wolfssh/settings.h index 023af26..9e248ad 100644 --- a/wolfssh/settings.h +++ b/wolfssh/settings.h @@ -16,7 +16,15 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The settings header provides a method for developers to provide the + * internal preprocessor defines that the configure script provides to + * environments that do not use the configure script. */ diff --git a/wolfssh/ssh.h b/wolfssh/ssh.h index 19e178c..de18e3e 100644 --- a/wolfssh/ssh.h +++ b/wolfssh/ssh.h @@ -16,7 +16,13 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The ssh module contains the public API for wolfSSH. */ diff --git a/wolfssh/version.h b/wolfssh/version.h index f897b0e..9cc62c1 100644 --- a/wolfssh/version.h +++ b/wolfssh/version.h @@ -16,7 +16,16 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The version header provides the current version number to the code + * based and is updated automatically by the configure script. A copy + * of the last generated copy of version.h is included with the + * distribution for environments that do not use configure. */ diff --git a/wolfssh/version.h.in b/wolfssh/version.h.in index 6bae0bb..37e24b9 100644 --- a/wolfssh/version.h.in +++ b/wolfssh/version.h.in @@ -16,7 +16,16 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The version header provides the current version number to the code + * based and is updated automatically by the configure script. A copy + * of the last generated copy of version.h is included with the + * distribution for environments that do not use configure. */ diff --git a/wolfssh/visibility.h b/wolfssh/visibility.h index 9b58c7e..deed823 100644 --- a/wolfssh/visibility.h +++ b/wolfssh/visibility.h @@ -16,7 +16,15 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + + +/* + * The visibility header handles the visibility of function prototypes + * between the local (used between modules in the library) and public + * (exported for the library user) APIs. */