Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Smaller Changes #4

Merged
merged 8 commits into from

2 participants

@vkroll

Hi,

read the docs again on the weekend and found some smaller issues, which you maybe want to incorporate.

Regards
Volker

Volker Kroll added some commits
Volker Kroll dns -> dsn in the SYNOPSIS 013b10b
Volker Kroll db_sandbox_class has an error in the documentation, talks one time of
Mysql as default the other time of SQLite. Removed the Mysql because it
is SQLite concerning the code
6142069
Volker Kroll in schema_args changed path to home_dir to path to target_dir 64d227d
Volker Kroll small typo da52319
Volker Kroll another small typo 662d792
Volker Kroll small typos and to fixes for POD syntax e1651b6
Volker Kroll missing ) 2e3327f
Volker Kroll small typo 701cae5
@jjn1056
Owner

These are great fixes! I'm really happy to see us focusing on documentation issues, since traditionally Perl projects have not always been so great at that.

When the book comes out you'll be sure to get cred :)

@jjn1056 jjn1056 merged commit 2fbdbc3 into jjn1056:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 12, 2012
  1. dns -> dsn in the SYNOPSIS

    Volker Kroll authored
  2. db_sandbox_class has an error in the documentation, talks one time of

    Volker Kroll authored
    Mysql as default the other time of SQLite. Removed the Mysql because it
    is SQLite concerning the code
  3. small typo

    Volker Kroll authored
  4. another small typo

    Volker Kroll authored
  5. small typos and to fixes for POD syntax

    Volker Kroll authored
  6. missing )

    Volker Kroll authored
  7. small typo

    Volker Kroll authored
This page is out of date. Refresh to see the latest.
View
8 lib/DBIx/Class/Migration.pm
@@ -543,7 +543,7 @@ running tests, for example.
=head2 db_sandbox_class
-Accepts Str. Not Required (defaults to 'DBIx::Class::Migration::MySQLSandbox').
+Accepts Str. Not Required (defaults to 'DBIx::Class::Migration::SqliteSandbox').
Unless you already have a database setup and running (as you probably do in
production) we need to auto create a database 'sandbox' that is isolated to
@@ -595,7 +595,7 @@ database connection with the following DSN:
DBD:SQLite:[path to target_dir]/[db_file_name].db
-Where c<[path to home_dir]> is L</target_dir> and [db_file_name] is a converted
+Where c<[path to target_dir]> is L</target_dir> and [db_file_name] is a converted
version of L</schema_class>. For example if you set L<schema_class> to:
MyApp::Schema
@@ -763,7 +763,7 @@ choose to leave this undefined.
=head3 Specify a schema
There may be some cases when you already have a schema object constructed and
-woudl prefer to just use that. For example, you may be using L<Catalyst> and
+would prefer to just use that. For example, you may be using L<Catalyst> and
wish to build custom scripts using the built-in dependency and service lookup:
use MyCatalyst::App;
@@ -774,7 +774,7 @@ wish to build custom scripts using the built-in dependency and service lookup:
%{MyCatalyst::App->config->{extra_migration_init_args}};
);
-Be care of potential locking issues when using some databases like SQLite.
+Be careful of potential locking issues when using some databases like SQLite.
=head3 OPTIONAL: Specify a target_dir
View
2  lib/DBIx/Class/Migration/FAQ.pod
@@ -254,7 +254,7 @@ There will be more like this:
shared_buffers or max_connections.
The solution is as presented. Since I prefer not to change my system settings
-permanently, " just add the following to a little bash script in my application
+permanently, just add the following to a little bash script in my application
sudo sysctl -w kern.sysv.shmall=65536
sudo sysctl -w kern.sysv.shmmax=16777216
View
12 lib/DBIx/Class/Migration/Script.pm
@@ -210,7 +210,7 @@ DBIx::Class::Migration::Script - Tools to manage database Migrations
dbic-migration status \
--libs="lib" \
--schema_class='MyApp::Schema' \
- --dns='DBI:SQLite:myapp.db'
+ --dsn='DBI:SQLite:myapp.db'
=head1 DESCRIPTION
@@ -396,7 +396,7 @@ development and postgresql in production. However this requires a bit more
setup effort, so when you are starting off just sticking to the default sqlite
is probably the easiest thing to do.
-YOu should review the documenation at L<DBIx::Class::Migration::MySQLSandbox> or
+You should review the documenation at L<DBIx::Class::Migration::MySQLSandbox> or
L<DBIx::Class::Migration::PostgresqlSandbox> because those delegates also build
some helper scripts, intended to help you use a sandbox.
@@ -405,7 +405,7 @@ DBIC_MIGRATION_SANDBOX_CLASS
If you need to create your own custom database sandboxes, please see:
L<DBIx::Class::Migration::Sandbox> which is the role your sandbox factory needs
-tp complete. You can signify your custom sandbox by using the full package name
+to complete. You can signify your custom sandbox by using the full package name
with a '+' prepended. For example:
sandbox_class => '+MyApp::Schema::CustomSandbox'
@@ -765,7 +765,7 @@ PostgresqlSandbox
Please see L<DBIx::Class::Migration::Tutorial> for more. Here's some basic use
cases.
-head2 Prepare deployment files for a schema
+=head2 Prepare deployment files for a schema
dbic_migration prepare --schema_class MyApp::Schema
@@ -776,7 +776,7 @@ This will prepare deployment files for just SQLite
This will prepare deployment files for both SQLite and MySQL
-head2 Install database from deployments
+=head2 Install database from deployments
dbic_migration install --schema_class MyApp::Schema
@@ -790,7 +790,7 @@ the most recent version
dbic_migration populate --schema_class MyApp::Schema --fixture_set seed
Populates the C<seed> fixture set to the current database (matches the database
-version to the seed version.
+version to the seed version.)
=head1 SEE ALSO
Something went wrong with that request. Please try again.