You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by ma...@apache.org on 2012/01/19 00:19:06 UTC
[lucy-commits] svn commit: r1233111 - in /incubator/lucy/trunk:
clownfish/perl/lib/Clownfish/CFC/Binding/Perl/Class.pm
clownfish/src/CFCPerlPod.c perl/buildlib/Lucy/Build/Binding/Index.pm
perl/buildlib/Lucy/Build/Binding/Object.pm
Author: marvin
Date: Wed Jan 18 23:19:06 2012
New Revision: 1233111
URL: http://svn.apache.org/viewvc?rev=1233111&view=rev
Log:
Remove POD-embedding hack.
Kill off an old stupid hack which was needed to hide quoted POD from
search.cpan.org.
Modified:
incubator/lucy/trunk/clownfish/perl/lib/Clownfish/CFC/Binding/Perl/Class.pm
incubator/lucy/trunk/clownfish/src/CFCPerlPod.c
incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Index.pm
incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm
Modified: incubator/lucy/trunk/clownfish/perl/lib/Clownfish/CFC/Binding/Perl/Class.pm
URL: http://svn.apache.org/viewvc/incubator/lucy/trunk/clownfish/perl/lib/Clownfish/CFC/Binding/Perl/Class.pm?rev=1233111&r1=1233110&r2=1233111&view=diff
==============================================================================
--- incubator/lucy/trunk/clownfish/perl/lib/Clownfish/CFC/Binding/Perl/Class.pm (original)
+++ incubator/lucy/trunk/clownfish/perl/lib/Clownfish/CFC/Binding/Perl/Class.pm Wed Jan 18 23:19:06 2012
@@ -223,13 +223,13 @@ sub create_pod {
# See the License for the specific language governing permissions and
# limitations under the License.
-==head1 NAME
+=head1 NAME
$class_name - $brief
$synopsis_pod
-==head1 DESCRIPTION
+=head1 DESCRIPTION
$description
@@ -239,14 +239,10 @@ $methods_pod
$inheritance_pod
-==cut
+=cut
END_POD
- # Kill off stupid hack which allows us to embed pod in this file without
- # messing up what you see when you perldoc it.
- $pod =~ s/^==/=/gm;
-
return $pod;
}
Modified: incubator/lucy/trunk/clownfish/src/CFCPerlPod.c
URL: http://svn.apache.org/viewvc/incubator/lucy/trunk/clownfish/src/CFCPerlPod.c?rev=1233111&r1=1233110&r2=1233111&view=diff
==============================================================================
--- incubator/lucy/trunk/clownfish/src/CFCPerlPod.c (original)
+++ incubator/lucy/trunk/clownfish/src/CFCPerlPod.c Wed Jan 18 23:19:06 2012
@@ -327,11 +327,8 @@ char*
CFCPerlPod_perlify_doc_text(CFCPerlPod *self, const char *source) {
(void)self; // unused
- // Remove double-equals hack needed to fool perldoc, PAUSE, etc. :P
- // char *copy = S_global_replace(source, "==", "=");
- char *copy = CFCUtil_strdup(source);
-
// Change <code>foo</code> to C<< foo >>.
+ char *copy = CFCUtil_strdup(source);
char *orig = copy;
copy = S_global_replace(orig, "<code>", "C<< ");
FREEMEM(orig);
Modified: incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Index.pm
URL: http://svn.apache.org/viewvc/incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Index.pm?rev=1233111&r1=1233110&r2=1233111&view=diff
==============================================================================
--- incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Index.pm (original)
+++ incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Index.pm Wed Jan 18 23:19:06 2012
@@ -587,7 +587,7 @@ END_XS_CODE
END_SYNOPSIS
my $constructor = <<'END_NEW';
-==head2 new( I<[labeled params]> )
+=head2 new( I<[labeled params]> )
my $indexer = Lucy::Index::Indexer->new(
schema => $schema, # required at index creation
@@ -597,39 +597,39 @@ END_SYNOPSIS
manager => $manager # default: created internally
);
-==over
+=over
-==item *
+=item *
B<schema> - A Schema. Required when index is being created; if not supplied,
will be extracted from the index folder.
-==item *
+=item *
B<index> - Either a filepath to an index or a Folder.
-==item *
+=item *
B<create> - If true and the index directory does not exist, attempt to create
it.
-==item *
+=item *
B<truncate> - If true, proceed with the intention of discarding all previous
indexing data. The old data will remain intact and visible until commit()
succeeds.
-==item *
+=item *
B<manager> - An IndexManager.
-==back
+=back
END_NEW
# Override is necessary because there's no standard way to explain
# hash/hashref across multiple host languages.
my $add_doc_pod = <<'END_ADD_DOC_POD';
-==head2 add_doc(...)
+=head2 add_doc(...)
$indexer->add_doc($doc);
$indexer->add_doc( { field_name => $field_value } );
@@ -641,18 +641,18 @@ END_NEW
Add a document to the index. Accepts either a single argument or labeled
params.
-==over
+=over
-==item *
+=item *
B<doc> - Either a Lucy::Document::Doc object, or a hashref (which will
be attached to a Lucy::Document::Doc object internally).
-==item *
+=item *
B<boost> - A floating point weight which affects how this document scores.
-==back
+=back
END_ADD_DOC_POD
Modified: incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm
URL: http://svn.apache.org/viewvc/incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm?rev=1233111&r1=1233110&r2=1233111&view=diff
==============================================================================
--- incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm (original)
+++ incubator/lucy/trunk/perl/buildlib/Lucy/Build/Binding/Object.pm Wed Jan 18 23:19:06 2012
@@ -648,7 +648,7 @@ All objects in the Lucy:: hierarchy desc
Lucy::Object::Obj. All classes are implemented as blessed scalar
references, with the scalar storing a pointer to a C struct.
-==head2 Subclassing
+=head2 Subclassing
The recommended way to subclass Lucy::Object::Obj and its descendants is
to use the inside-out design pattern. (See L<Class::InsideOut> for an
@@ -666,25 +666,25 @@ C<$$self> can be used as an inside-out I
Caveats:
-==over
+=over
-==item *
+=item *
Inside-out aficionados will have noted that the "cached scalar id" stratagem
recommended above isn't compatible with ithreads -- but Lucy doesn't
support ithreads anyway, so it doesn't matter.
-==item *
+=item *
Overridden methods must not return undef unless the API specifies that
returning undef is permissible. (Failure to adhere to this rule currently
results in a segfault rather than an exception.)
-==back
+=back
-==head1 CONSTRUCTOR
+=head1 CONSTRUCTOR
-==head2 new()
+=head2 new()
Abstract constructor -- must be invoked via a subclass. Attempting to
instantiate objects of class "Lucy::Object::Obj" directly causes an
@@ -692,9 +692,9 @@ error.
Takes no arguments; if any are supplied, an error will be reported.
-==head1 DESTRUCTOR
+=head1 DESTRUCTOR
-==head2 DESTROY
+=head2 DESTROY
All Lucy classes implement a DESTROY method; if you override it in a
subclass, you must call C<< $self->SUPER::DESTROY >> to avoid leaking memory.