Doc: clean up pg_relation_check_pages() documentation.
authorTom Lane
Wed, 28 Oct 2020 21:03:05 +0000 (17:03 -0400)
committerTom Lane
Wed, 28 Oct 2020 21:03:05 +0000 (17:03 -0400)
Commit f2b883969 did not get the memo about the new formatting
style for tables documenting built-in functions.  I noticed because
of a PDF build warning about an overwidth table.

doc/src/sgml/func.sgml

index 7ef2ec99725965707ea1d31869619a2f653b5eda..d8eee3a8264320c2ae9660e4d0235a41f279f719 100644 (file)
@@ -26192,44 +26192,50 @@ SELECT convert_from(pg_read_binary_file('file_in_utf8.txt'), 'UTF8');
 
    
     Data Sanity Functions
-    3">
+    1">
      
-      Name Return Type Description
+      
+       
+        Function
+       
+       
+        Description
+       
       
      
 
      
       
-       
-        pg_relation_check_pages(relation regclass [, fork text DEFAULT NULL ])
-       
-       setof record
-       Check the pages of a relation.
-       
+       
+        
+         pg_relation_check_pages
+        
+        pg_relation_check_pages ( relation regclass [, fork text ] )
+        setof record
+        ( path text,
+        failed_block_num bigint )
+       
+       
+        Checks the pages of the specified relation to see if they are valid
+        enough to safely be loaded into the server's shared buffers.  If
+        given, fork specifies that only the pages of
+        the given fork are to be verified.  fork can
+        be main for the main data
+        fork, fsm for the free space
+        map, vm for the visibility map,
+        or init for the initialization fork.  The
+        default of NULL means that all forks of the
+        relation should be checked.  The function returns a list of block
+        numbers that appear corrupted along with the path names of their
+        files.  Use of this function is restricted to superusers by
+        default, but access may be granted to others
+        using GRANT.
+       
       
      
     
    
 
-   
-    pg_relation_check_pages
-   
-   
-    pg_relation_check_pages iterates over all blocks of a
-    given relation and verifies if they are in a state where they can safely
-    be loaded into the shared buffers. If defined,
-    fork specifies that only the pages of the given
-    fork are to be verified. Fork can be 'main' for the
-    main data fork, 'fsm' for the free space map,
-    'vm' for the visibility map, or
-    'init' for the initialization fork.  The default of
-    NULL means that all the forks of the relation are
-    checked. The function returns a list of blocks that are considered as
-    corrupted with the path of the related file. Use of this function is
-    restricted to superusers by default but access may be granted to others
-    using GRANT.
-   
-