From 176067df1adfe313e1105cc1508ff8603e25c9e6 Mon Sep 17 00:00:00 2001 From: Jim Blandy Date: Thu, 16 Mar 2000 21:11:45 +0000 Subject: [PATCH] Doc fix. --- libguile/__scm.h | 12 ++++++++++++ libguile/_scm.h | 14 ++++++++++++-- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/libguile/__scm.h b/libguile/__scm.h index 43698e4c4..889572bbb 100644 --- a/libguile/__scm.h +++ b/libguile/__scm.h @@ -43,6 +43,18 @@ * whether to permit this exception to apply to your modifications. * If you do not wish that, delete this exception notice. */ + +/* "What's the difference between _scm.h and __scm.h?" + + _scm.h is not installed; it's only visible to the libguile sources + themselves. + + __scm.h is installed, and is #included by . If both + the client and libguile need some piece of information, and it + doesn't fit well into the header file for any particular module, it + should go in __scm.h. */ + + /* {Supported Options} * * These may be defined or undefined. diff --git a/libguile/_scm.h b/libguile/_scm.h index 7bc1ce1e5..b76f38d1c 100644 --- a/libguile/_scm.h +++ b/libguile/_scm.h @@ -2,7 +2,7 @@ #ifndef _SCMH #define _SCMH -/* Copyright (C) 1995,1996 Free Software Foundation, Inc. +/* Copyright (C) 1995,1996, 2000 Free Software Foundation, Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -46,7 +46,17 @@ #include "__scm.h" -/* This file is only visible to the libguile sources */ +/* "What's the difference between _scm.h and __scm.h?" + + _scm.h is not installed; it's only visible to the libguile sources + themselves. + + __scm.h is installed, and is #included by . If both + the client and libguile need some piece of information, and it + doesn't fit well into the header file for any particular module, it + should go in __scm.h. */ + + /* Include headers for those files central to the implementation. The rest should be explicitly #included in the C files themselves. */