public inbox for [email protected]  
help / color / mirror / Atom feed
CREATE EXTENSION: documenting prereqs
3+ messages / 2 participants
[nested] [flat]

* CREATE EXTENSION: documenting prereqs
@ 2011-04-12 22:52  Josh Kupershmidt <[email protected]>
  0 siblings, 1 reply; 3+ messages in thread

From: Josh Kupershmidt @ 2011-04-12 22:52 UTC (permalink / raw)
  To: pgsql-docs

Hi all,

I think users of 9.1 will be interested in quickly seeing what
extensions are all about. Looking at the CREATE EXTENSION page[2],
there's a brief example showing the command:
|  CREATE EXTENSION hstore;

When I try this, I see something like:
|   ERROR:  could not open extension control file
"/Users/josh/runtime/share/postgresql/extension/hstore.control": No
such file or directory

Well, obviously I need to go into ./contrib/hstore/ and run make &&
make install (or install the appropriate -contrib package if I were
using a packaged build of Postgres). I think it'd be nice to give
users some hint about this prerequisite. Appendix F [1] discusses
this, but there's currently no link from [2] to [1]. The way the
CREATE EXTENSION page reads right now, I could forgive a new user
thinking he shouldn't need to install any dependencies.

A complementary approach would be to add an errhint to the "could not
open extension control file..." error suggesting that the user install
the contrib package himself, though I'm not sure offhand about the
wording, especially since a user might be trying to install
who-knows-what extension.

A possible patch for the CREATE EXTENSION page is attached.

Josh

--
[1] http://developer.postgresql.org/pgdocs/postgres/contrib.html
[2] http://developer.postgresql.org/pgdocs/postgres/sql-createextension.html


Attachments:

  [text/x-patch] create_extension.v4.patch (783B, 2-create_extension.v4.patch)
  download | inline diff:
diff --git a/doc/src/sgml/ref/create_extension.sgml b/doc/src/sgml/ref/create_extension.sgml
index 818bc0c..e862c7f 100644
*** a/doc/src/sgml/ref/create_extension.sgml
--- b/doc/src/sgml/ref/create_extension.sgml
*************** CREATE EXTENSION hstore;
*** 153,158 ****
--- 153,169 ----
  </programlisting>
    </para>
  
+   <note>
+    <para>
+     For more information on how to use
+     <command>CREATE EXTENSION</command> to install modules
+     found in <productname>PostgreSQL</productname>'s
+     <literal>contrib</literal> directory, such as the hstore
+     extension, please see
+     <link linkend="contrib">Additional Supplied Modules</link>.
+    </para>
+   </note>
+ 
    <para>
     Update a pre-9.1 installation of <literal>hstore</> into
     extension style:


^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: CREATE EXTENSION: documenting prereqs
@ 2011-04-13 07:00  Tom Lane <[email protected]>
  parent: Josh Kupershmidt <[email protected]>
  0 siblings, 1 reply; 3+ messages in thread

From: Tom Lane @ 2011-04-13 07:00 UTC (permalink / raw)
  To: Josh Kupershmidt <[email protected]>; +Cc: pgsql-docs

Josh Kupershmidt <[email protected]> writes:
> Well, obviously I need to go into ./contrib/hstore/ and run make &&
> make install (or install the appropriate -contrib package if I were
> using a packaged build of Postgres). I think it'd be nice to give
> users some hint about this prerequisite. Appendix F [1] discusses
> this, but there's currently no link from [2] to [1]. The way the
> CREATE EXTENSION page reads right now, I could forgive a new user
> thinking he shouldn't need to install any dependencies.

On reflection there are a couple other cross-references that would
be useful here, too.  I've committed a modified version of this.

> A complementary approach would be to add an errhint to the "could not
> open extension control file..." error suggesting that the user install
> the contrib package himself, though I'm not sure offhand about the
> wording, especially since a user might be trying to install
> who-knows-what extension.

Yeah, I'm not sure how to do anything useful in one-or-so-lines there.

			regards, tom lane



^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: CREATE EXTENSION: documenting prereqs
@ 2011-04-15 00:52  Josh Kupershmidt <[email protected]>
  parent: Tom Lane <[email protected]>
  0 siblings, 0 replies; 3+ messages in thread

From: Josh Kupershmidt @ 2011-04-15 00:52 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: pgsql-docs

On Wed, Apr 13, 2011 at 3:00 AM, Tom Lane <[email protected]> wrote:
> On reflection there are a couple other cross-references that would
> be useful here, too.  I've committed a modified version of this.

Thanks, that looks much improved.

Josh




^ permalink  raw  reply  [nested|flat] 3+ messages in thread


end of thread, other threads:[~2011-04-15 00:52 UTC | newest]

Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2011-04-12 22:52 CREATE EXTENSION: documenting prereqs Josh Kupershmidt <[email protected]>
2011-04-13 07:00 ` Tom Lane <[email protected]>
2011-04-15 00:52   ` Josh Kupershmidt <[email protected]>

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox