Re: Proposal: adding a better description in psql command about large objects - Mailing list pgsql-hackers

Nathan Bossart <nathandbossart@gmail.com> writes:
> On Fri, Jun 03, 2022 at 11:12:11AM -0400, Tom Lane wrote:
>> * While we're here, it seems like this whole group was placed at the
>> end because of add-it-to-the-end-itis, not because that was the
>> most logical place for it.  The other commands that interact with
>> the server are mostly further up.  My first thought is to move it
>> to just after the "Informational" group, but I'm not especially
>> set on that.  Making it not-last might make it harder to get away
>> with the inconsistent indentation, though.

> Another option could be to move it after the "Input/Output" section so that
> it's closer to some other commands that involve files.  I can't say I have
> a strong opinion about whether/where to move it, though.

Yeah, I thought of that choice too, but it ends up placing the
Large Objects section higher up the list than seems warranted on
frequency-of-use grounds.

After looking at the output I concluded that we'd be better off to
stick with the normal indentation amount, and break the lo_import
entry into two lines to make that work.  One reason for this is
that some translators might've already settled on a different
indentation amount in order to cope with translated parameter names,
and deviating from the normal here will just complicate their lives.
So that leaves me proposing v5.

(I also fixed the out-of-date line count in helpVariables.)

            regards, tom lane

diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c
index 49eb116f33..81a4739cda 100644
--- a/src/bin/psql/help.c
+++ b/src/bin/psql/help.c
@@ -163,7 +163,7 @@ slashUsage(unsigned short int pager)
      * Use "psql --help=commands | wc" to count correctly.  It's okay to count
      * the USE_READLINE line even in builds without that.
      */
-    output = PageOutput(138, pager ? &(pset.popt.topt) : NULL);
+    output = PageOutput(139, pager ? &(pset.popt.topt) : NULL);

     fprintf(output, _("General\n"));
     fprintf(output, _("  \\copyright             show PostgreSQL usage and distribution terms\n"));
@@ -272,6 +272,14 @@ slashUsage(unsigned short int pager)
     fprintf(output, _("  \\z      [PATTERN]      same as \\dp\n"));
     fprintf(output, "\n");

+    fprintf(output, _("Large Objects\n"));
+    fprintf(output, _("  \\lo_export LOBOID FILE write large object to file\n"));
+    fprintf(output, _("  \\lo_import FILE [COMMENT]\n"
+                      "                         read large object from file\n"));
+    fprintf(output, _("  \\lo_list[+]            list large objects\n"));
+    fprintf(output, _("  \\lo_unlink LOBOID      delete a large object\n"));
+    fprintf(output, "\n");
+
     fprintf(output, _("Formatting\n"));
     fprintf(output, _("  \\a                     toggle between unaligned and aligned output mode\n"));
     fprintf(output, _("  \\C [STRING]            set table title, or unset if none\n"));
@@ -318,13 +326,6 @@ slashUsage(unsigned short int pager)
     fprintf(output, _("  \\prompt [TEXT] NAME    prompt user to set internal variable\n"));
     fprintf(output, _("  \\set [NAME [VALUE]]    set internal variable, or list all if no parameters\n"));
     fprintf(output, _("  \\unset NAME            unset (delete) internal variable\n"));
-    fprintf(output, "\n");
-
-    fprintf(output, _("Large Objects\n"));
-    fprintf(output, _("  \\lo_export LOBOID FILE\n"
-                      "  \\lo_import FILE [COMMENT]\n"
-                      "  \\lo_list[+]\n"
-                      "  \\lo_unlink LOBOID      large object operations\n"));

     ClosePager(output);
 }
@@ -346,7 +347,7 @@ helpVariables(unsigned short int pager)
      * Windows builds currently print one fewer line than non-Windows builds.
      * Using the larger number is fine.
      */
-    output = PageOutput(161, pager ? &(pset.popt.topt) : NULL);
+    output = PageOutput(163, pager ? &(pset.popt.topt) : NULL);

     fprintf(output, _("List of specially treated variables\n\n"));