Re: Idea: Take out the Config.pm embedded documentation

 
From: "Dada Mail" <dada@PROTECTED>
Date: July 24th 2006

On Jul 23, 2006, at 12:45 AM, Andreas Grau wrote: >

I vote for leaving it in the file It is part of the documentation, pod's are invented and used for reason, and people wanting to dig deeper into things need it

OK - one vote for leaving it in :)

Personlly, I can't see why it should be difficult to wait with
changing until one sees a =cut People obviously read the file and then spontaneously decide to change the file Difficult ? Yes ! Difficult people ! ;-)

Well, the problem is, if you don't know how pod works, the examples
embedded in the pod may seem like what you're actually supposed to
change - here's an example:

[snip]

 =head2 @ALLOWED_IP_ADDRESSES

 You can block anyone from using any list control panel by
 specifying exactly what IP addresses are allowed
 Leave the
 @ALLOWED_IP_ADDRESSES blank:

     @ALLOWED_IP_ADDRESSES = qw();

 to disable this security measure


 To add an address, just list it, like this:

     @ALLOWED_IP_ADDRESSES = qw(123
456
67
678
                                215
234
56
9
                                783
456
9
2);

 =cut

 @ALLOWED_IP_ADDRESSES = qw()
     unless scalar @ALLOWED_IP_ADDRESSES;

 =pod

[/snip]

Now, it is sort of trick to understand which, "@ALLOWED_IP_ADDRESSES"
I'm supposed to change Without the pod, it would just look like this:

[snip] @ALLOWED_IP_ADDRESSES = qw() unless scalar @ALLOWED_IP_ADDRESSES; [/snip]

Here's another problem, if you're reading the pod embedded, and
trying to change a variable, sometimes the formatting of the pod
itself gets in the way, example pod:

[snip]

 =head2 $ARCHIVE_DB_TYPE

 Similar to $SUBSCRIBER_DB_TYPE, I<$ARCHIVE_DB_TYPE> refers to  

what database type you'd like to be using for Dada Mail's archives The default is B, which refers to the DB File format (The Berkeley DB_File
format)

 Available also are B<MySQL> and B<PostgreSQL>


 Set $ARCHIVE_DB_TYPE to B<MySQL> for Mysql, B<PostgreSQL> for  

Postgres

 If you do use a SQL database, you most likely have to tweak
 the B<%SQL_PARAMS> hash


 =cut

 $ARCHIVE_DB_TYPE  ||= 'Db';

[/snip]

I had a report that someone set, $ARCHIVE_DB_TYPE to:

$ARCHIVE_DB_TYPE ||= B<MySQL>

Which is totally wrong, but it's exactly what the pod says

  • This mailing list is a public mailing list - anyone may join or leave, at any time.
  • This mailing list is a group discussion list (unmoderated)
  • Start a new thread, email: dadadev@dadamailproject.com

This is the developer discussion mailing list for Dada Mail.

If you are just looking for support Dada Mail, consult the message boards at:

https://forum.dadamailproject.com

Documentation for Dada Mail:

https://dadamailproject.com/d

Specifically, see the Error FAQ:

https://dadamailproject.com/d/FAQ-errors.pod.html

To post to this list, send a message to:

mailto:dadadev@dadamailproject.com

All subscribers of this list may post to the list itself.

Topics that are welcome:

  • Constructive critiques on the program (I like, "x", but, "y" needs some work - here's an idea on how to make this better...)
  • Bug/Error reports
  • Bug fixes
  • Request For Comments on any changes to the program
  • Help customizing Dada Mail for your own needs
  • Patches
  • Language Translations
  • Support Documentation/Doc editing, FAQ's, etc.
  • Discussion of any changes that you would like to be committed to the next version of Dada Mail -

Dada Mail is on Github:

https://github.com/justingit/dada-mail/

If you would like to fork, branch, send over PRs, open up issues, etc.

Privacy Policy:

This Privacy Policy is for this mailing list, and this mailing list only.

Email addresses collection through this mailing list are used explicitly to work within this email discussion list.

We only collect email addresses through our Closed-Loop Opt-In system.

We don't use your email address for any other purpose.

We won't be sharing your email address with any other entity.

Unsubscription can be done at any time. Please contact us at: justin@dadamailproject.com for any help regarding your subscription, including removal from the mailing list.

All mailing list messages sent from us will include a subscription removal link, which will allow you to remove yourself from this mailing list automatically, and permanently.

All consent to use your email address for any other purpose stated at the time of the mailing list subscription will also be revoked upon mailing list removal.