summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDickson S. Guedes2011-05-12 04:45:08 +0000
committerDickson S. Guedes2011-05-12 04:45:08 +0000
commit6cfa0d70fec134a34d22154ec51754d16249da19 (patch)
treed278f5a8ae3f9259ff28ccf8823ba6f71d629000
parentc90859f8785884130fbe8c921dbe25a16df08d1c (diff)
added more texts to templates
-rw-r--r--lib/pgxn_utils/templates/root/README.md.tt80
-rw-r--r--lib/pgxn_utils/templates/root/doc/%extension_name%.md.tt29
-rw-r--r--lib/pgxn_utils/templates/root/test/expected/base.out2
-rw-r--r--lib/pgxn_utils/templates/root/test/sql/base.sql0
-rw-r--r--lib/pgxn_utils/templates/root/test/sql/base.sql.tt8
-rw-r--r--spec/cli_spec.rb1
6 files changed, 120 insertions, 0 deletions
diff --git a/lib/pgxn_utils/templates/root/README.md.tt b/lib/pgxn_utils/templates/root/README.md.tt
new file mode 100644
index 0000000..dea5186
--- /dev/null
+++ b/lib/pgxn_utils/templates/root/README.md.tt
@@ -0,0 +1,80 @@
+<%= extension_name %>
+<%= extension_name.gsub(/./,"=") %>
+
+<%= description %>
+
+To build it, just do this:
+
+ make
+ make installcheck
+ make install
+
+If you encounter an error such as:
+
+ "Makefile", line 8: Need an operator
+
+You need to use GNU make, which may well be installed on your system as
+`gmake`:
+
+ gmake
+ gmake install
+ gmake installcheck
+
+If you encounter an error such as:
+
+ make: pg_config: Command not found
+
+Be sure that you have `pg_config` installed and in your path. If you used a
+package management system such as RPM to install PostgreSQL, be sure that the
+`-devel` package is also installed. If necessary tell the build process where
+to find it:
+
+ env PG_CONFIG=/path/to/pg_config make && make installcheck && make install
+
+And finally, if all that fails (and if you're on PostgreSQL 8.1 or lower, it
+likely will), copy the entire distribution directory to the `contrib/`
+subdirectory of the PostgreSQL source tree and try it there without
+`pg_config`:
+
+ env NO_PGXS=1 make && make installcheck && make install
+
+If you encounter an error such as:
+
+ ERROR: must be owner of database regression
+
+You need to run the test suite using a super user, such as the default
+"postgres" super user:
+
+ make installcheck PGUSER=postgres
+
+Once <%= extension_name %> is installed, you can add it to a database. If you're running
+PostgreSQL 9.1.0 or greater, it's a simple as connecting to a database as a
+super user and running:
+
+ CREATE EXTENSION <%= extension_name %>;
+
+If you've upgraded your cluster to PostgreSQL 9.1 and already had <%= extension_name %>
+installed, you can upgrade it to a properly packaged extension with:
+
+ CREATE EXTENSION <%= extension_name %> FROM unpackaged;
+
+For versions of PostgreSQL less than 9.1.0, you'll need to run the
+installation script:
+
+ psql -d mydb -f /path/to/pgsql/share/contrib/<%= extension_name %>.sql
+
+If you want to install <%= extension_name %> and all of its supporting objects into a specific
+schema, use the `PGOPTIONS` environment variable to specify the schema, like
+so:
+
+ PGOPTIONS=--search_path=extensions psql -d mydb -f <%= extension_name %>.sql
+
+Dependencies
+------------
+The `<%= extension_name %>` data type has no dependencies other than PostgreSQL.
+
+Copyright and License
+---------------------
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= maintainer %>.
+
diff --git a/lib/pgxn_utils/templates/root/doc/%extension_name%.md.tt b/lib/pgxn_utils/templates/root/doc/%extension_name%.md.tt
index aaef9a4..4df92fe 100644
--- a/lib/pgxn_utils/templates/root/doc/%extension_name%.md.tt
+++ b/lib/pgxn_utils/templates/root/doc/%extension_name%.md.tt
@@ -1,4 +1,33 @@
<%= extension_name %>
<%= extension_name.gsub(/./,"=") %>
+Synopsis
+--------
+
+ Show a brief synopsis of the extension.
+
+Description
+-----------
+
<%= description %>
+
+Usage
+-----
+
+ Show usage.
+
+Support
+-------
+
+ There is issues tracker? Github? Put this information here.
+
+Author
+------
+
+[<%= maintainer %>]
+
+Copyright and License
+---------------------
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= maintainer %>.
+
diff --git a/lib/pgxn_utils/templates/root/test/expected/base.out b/lib/pgxn_utils/templates/root/test/expected/base.out
index e69de29..6cc5058 100644
--- a/lib/pgxn_utils/templates/root/test/expected/base.out
+++ b/lib/pgxn_utils/templates/root/test/expected/base.out
@@ -0,0 +1,2 @@
+\set ECHO 0
+ROLLBACK;
diff --git a/lib/pgxn_utils/templates/root/test/sql/base.sql b/lib/pgxn_utils/templates/root/test/sql/base.sql
deleted file mode 100644
index e69de29..0000000
--- a/lib/pgxn_utils/templates/root/test/sql/base.sql
+++ /dev/null
diff --git a/lib/pgxn_utils/templates/root/test/sql/base.sql.tt b/lib/pgxn_utils/templates/root/test/sql/base.sql.tt
new file mode 100644
index 0000000..3c163b8
--- /dev/null
+++ b/lib/pgxn_utils/templates/root/test/sql/base.sql.tt
@@ -0,0 +1,8 @@
+\set ECHO 0
+BEGIN;
+\i sql/<%= extension_name %>.sql
+\set ECHO all
+
+-- Tests goes here.
+
+ROLLBACK;
diff --git a/spec/cli_spec.rb b/spec/cli_spec.rb
index a77de03..9a28ca8 100644
--- a/spec/cli_spec.rb
+++ b/spec/cli_spec.rb
@@ -58,6 +58,7 @@ describe PgxnUtils::CLI do
Dir["#{extension}/**/*"].sort.should == [
"#{extension}/META.json",
"#{extension}/Makefile",
+ "#{extension}/README.md",
"#{extension}/doc",
"#{extension}/doc/#{extension}.md",
"#{extension}/sql",