]> granicus.if.org Git - postgresql/commitdiff
Bring references to ipcclean in sync with reality.
authorPeter Eisentraut <peter_e@gmx.net>
Tue, 4 Sep 2001 00:22:34 +0000 (00:22 +0000)
committerPeter Eisentraut <peter_e@gmx.net>
Tue, 4 Sep 2001 00:22:34 +0000 (00:22 +0000)
doc/src/sgml/ref/ipcclean.sgml
src/backend/storage/ipc/ipc.c

index cb468f8c615c5ecfb49a61b7d9de9ea7a1e40920..7c4fc5647e76c4688ddd91f547e033c6db74c8ac 100644 (file)
@@ -1,5 +1,5 @@
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/ipcclean.sgml,v 1.4 2001/09/03 12:57:50 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/ipcclean.sgml,v 1.5 2001/09/04 00:22:34 petere Exp $
 Postgres documentation
 -->
 
@@ -28,35 +28,36 @@ Postgres documentation
  <refsect1 id="R1-APP-IPCCLEAN-1">
   <title>Description</title>
   <para>
-   <application>ipcclean</application>
-   cleans up shared memory and semaphore space from aborted backends by
-   deleting all instances owned by user <literal>postgres</literal>.
-   Only the DBA
-   should execute this program as it can cause bizarre behavior (i.e.,
-   crashes) if run during multi-user execution.  This program should be
-   executed if messages such as
-
-   <computeroutput>
-semget: No space left on device
-   </computeroutput>
-
-   are encountered when starting up the 
-   <application>postmaster</application> or the backend server.
+   <command>ipcclean</command> removes all shared memory segments and
+   semaphore sets owned by the current user.  It is intended to be
+   used for cleaning up after a crashed
+   <productname>PostgreSQL</productname> server (<xref
+   linkend="app-postmaster">).  Note that immediately restarting the
+   server will also clean up shared memory and semaphores, so this
+   command is of little real utility.
   </para>
 
   <para>
-   If this command is executed while <application>postmaster</application>
-   is running, the shared memory and semaphores allocated by the
-   <application>postmaster</application>
-   will be deleted.  This will result in a general failure of the
-   backend servers started by that
+   Only the database administrator should execute this program as it
+   can cause bizarre behavior (i.e., crashes) if run during multiuser
+   execution.  If this command is executed while a
+   <application>postmaster</application> is running, the shared memory
+   and semaphores allocated by the
+   <application>postmaster</application> will be deleted.  This will
+   result in a general failure of the backend servers started by that
    <application>postmaster</application>.
   </para>
+ </refsect1>
+
+ <refsect1>
+  <title>Notes</title>
 
   <para>
-   This script is a hack, but in the many years since it was written, no
-   one has come up with an equally effective and portable solution.
-   Suggestions are welcome.
+   This script is a hack, but in the many years since it was written,
+   no one has come up with an equally effective and portable solution.
+   Since the <application>postmaster</application> can now clean up by
+   itself, it is unlikely that <command>ipcclean</command> will be
+   improved upon in the future.
   </para>
 
   <para>
@@ -66,6 +67,7 @@ semget: No space left on device
    Therefore, it may not work on your particular OS.
   </para>
  </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file
index 2d2a0b252356c1d8823afb2753f10f98b830d292..b5871a5e09736fd7cead3f63571d735c85fa2290 100644 (file)
@@ -8,7 +8,7 @@
  *
  *
  * IDENTIFICATION
- *       $Header: /cvsroot/pgsql/src/backend/storage/ipc/ipc.c,v 1.67 2001/05/08 19:00:26 momjian Exp $
+ *       $Header: /cvsroot/pgsql/src/backend/storage/ipc/ipc.c,v 1.68 2001/09/04 00:22:34 petere Exp $
  *
  * NOTES
  *
@@ -596,9 +596,8 @@ InternalIpcMemoryCreate(IpcMemoryKey memKey, uint32 size, int permission)
                                        "2. The requested shared memory segment was too small for your system.\n"
                                        "   You need to lower the SHMMIN parameter in your kernel.\n\n"
                                        "3. The requested shared memory segment already exists but is of the\n"
-                                       "   wrong size.  This is most likely the case if an old version of\n"
-                                       "   PostgreSQL crashed and didn't clean up.  The `ipcclean' utility\n"
-                                       "   can be used to remedy this.\n\n"
+                                       "   wrong size.  This can occur if some other application on your system\n"
+                                       "   is also using shared memory.\n\n"
                                        "The PostgreSQL Administrator's Guide contains more information about\n"
                                        "shared memory configuration.\n\n",
                                        size);