Skip to content

Commit 3007bb0

Browse files
oodler577oodler577
committed
POD fixup
1 parent 1322f09 commit 3007bb0

File tree

2 files changed

+64
-66
lines changed

2 files changed

+64
-66
lines changed

‎README.md

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -41,42 +41,44 @@ At this time, the following compilers are supported:
4141

4242
## Note On Compiler Support
4343

44-
If used for an unsupported compiler, `ExtUtils::MakeMaker::os_unsupported` is
45-
invoked, which results an exception propagating from this method being raised
46-
with the value of `qq{OS unsupported\n}` (note the new line).
44+
If used for an unsupported compiler, `ExtUtils::MakeMaker::os_unsupported`
45+
is invoked, which results an exception propagating from this method being
46+
raised with the value of `qq{OS unsupported\n}` (note the new line).
4747

4848
This module assumes that the compiler in question is the same one used to
49-
build `perl`. Since the vast majority of `perl`s are building using `gcc`,
50-
initial support is targeting it. However, like `perl`, many other compilers
51-
may be used.
49+
build `perl`. Since the vast majority of `perl`s are building using
50+
`gcc`, initial support is targeting it. However, like `perl`, many
51+
other compilers may be used.
5252

53-
Adding support for a new compiler should be straightforward; please section on
54-
contributing, below.
53+
Adding support for a new compiler should be straightforward; please
54+
section on contributing, below.
5555

5656
## Contributing
5757

58-
The biggest need is to support additional compilers. OpenMP is a well established
59-
standard across compilers, but there is guarantee that all compilers will use the
60-
same flags, library names, or header files. It should also be easy to contribute
61-
a patch to add this information, which is effectively its purpose. At the very least,
62-
please create an issue at the official issue tracker to request this support, and
63-
be sure to include the relevant information. Chances are the maintainers of this
58+
The biggest need is to support additional compilers. OpenMP is a well
59+
established standard across compilers, but there is no guarantee that
60+
all compilers will use the same flags, library names, or header files. It
61+
should also be easy to contribute a patch to add this information, which
62+
is effectively its purpose. At the very least, please create an issue
63+
at the official issue tracker to request this support, and be sure to
64+
include the relevant information. Chances are the maintainers of this
6465
module do not have access to an unsupported compiler.
6566

6667
# METHODS
6768

6869
- `cflags`
6970

7071
Returns flag used by a supported compiler to enable OpenMP. If not support,
71-
an empty string is provided since by definition all OpenMP programs must compile
72-
because OpenMP pramgas are annotations hidden behind source code comments.
72+
an empty string is provided since by definition all OpenMP programs
73+
must compile because OpenMP pramgas are annotations hidden behind source
74+
code comments.
7375

7476
Example, GCC uses, `-fopenmp`.
7577

7678
- `lddlflags`
7779

78-
Returns the flag used by the linker to enable OpenMP. This is usually the same
79-
as what is returned by `cflags`.
80+
Returns the flag used by the linker to enable OpenMP. This is usually
81+
the same as what is returned by `cflags`.
8082

8183
Example, GCC uses, `-fopenmp`, for this as well.
8284

@@ -86,36 +88,33 @@ module do not have access to an unsupported compiler.
8688
[Inline](https://metacpan.org/pod/Inline)). This method is not called directly, but used when compiling
8789
OpenMP programs with `Inline::C`:
8890

89-
use Alien::OpenMP;
90-
use Inline (
91-
C => 'DATA',
92-
with => qw/Alien::OpenMP/,
91+
use Alien::OpenMP; use Inline (
92+
C => 'DATA', with => qw/Alien::OpenMP/,
9393
);
9494

9595
The nice, compact form above replaces this mess:
9696

97-
use Alien::OpenMP;
98-
use Inline (
99-
C => 'DATA',
100-
ccflagsex => Alien::OpenMP::cflags(),
101-
lddlflags => join( q{ }, $Config::Config{lddlflags}, Alien::OpenMP::lddlflags() ),
97+
use Alien::OpenMP; use Inline (
98+
C => 'DATA', ccflagsex => Alien::OpenMP::cflags(),
99+
lddlflags => join( q{ }, $Config::Config{lddlflags},
100+
Alien::OpenMP::lddlflags() ),
102101
);
103102

104103
- `_check_libs`
105104

106105
Internal method.
107106

108-
Returns an array reference of libraries, e.g., `gomp` for `gcc`. It is meant
109-
specifically as an internal method to support [Devel::CheckLib](https://metacpan.org/pod/Devel%3A%3ACheckLib) in this module's
110-
`Makefile.PL`.
107+
Returns an array reference of libraries, e.g., `gomp` for `gcc`. It is
108+
meant specifically as an internal method to support [Devel::CheckLib](https://metacpan.org/pod/Devel%3A%3ACheckLib)
109+
in this module's `Makefile.PL`.
111110

112111
- `_check_headers`
113112

114113
Internal method.
115114

116-
Returns an array reference of header files, e.g., `omp.h` for `gcc`. It is meant
117-
specifically as an internal method to support [Devel::CheckLib](https://metacpan.org/pod/Devel%3A%3ACheckLib) in this module's
118-
`Makefile.PL`.
115+
Returns an array reference of header files, e.g., `omp.h` for `gcc`. It
116+
is meant specifically as an internal method to support [Devel::CheckLib](https://metacpan.org/pod/Devel%3A%3ACheckLib)
117+
in this module's `Makefile.PL`.
119118

120119
# AUTHOR
121120

‎lib/Alien/OpenMP.pm

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -128,26 +128,27 @@ C<-fopenmp> enables OpenMP support in via compiler and linker:
128128
129129
=head2 Note On Compiler Support
130130
131-
If used for an unsupported compiler, C<ExtUtils::MakeMaker::os_unsupported> is
132-
invoked, which results an exception propagating from this method being raised
133-
with the value of C<qq{OS unsupported\n}> (note the new line).
131+
If used for an unsupported compiler, C<ExtUtils::MakeMaker::os_unsupported>
132+
is invoked, which results an exception propagating from this method being
133+
raised with the value of C<qq{OS unsupported\n}> (note the new line).
134134
135135
This module assumes that the compiler in question is the same one used to
136-
build C<perl>. Since the vast majority of C<perl>s are building using C<gcc>,
137-
initial support is targeting it. However, like C<perl>, many other compilers
138-
may be used.
136+
build C<perl>. Since the vast majority of C<perl>s are building using
137+
C<gcc>, initial support is targeting it. However, like C<perl>, many
138+
other compilers may be used.
139139
140-
Adding support for a new compiler should be straightforward; please section on
141-
contributing, below.
140+
Adding support for a new compiler should be straightforward; please
141+
section on contributing, below.
142142
143143
=head2 Contributing
144144
145-
The biggest need is to support additional compilers. OpenMP is a well established
146-
standard across compilers, but there is guarantee that all compilers will use the
147-
same flags, library names, or header files. It should also be easy to contribute
148-
a patch to add this information, which is effectively its purpose. At the very least,
149-
please create an issue at the official issue tracker to request this support, and
150-
be sure to include the relevant information. Chances are the maintainers of this
145+
The biggest need is to support additional compilers. OpenMP is a well
146+
established standard across compilers, but there is no guarantee that
147+
all compilers will use the same flags, library names, or header files. It
148+
should also be easy to contribute a patch to add this information, which
149+
is effectively its purpose. At the very least, please create an issue
150+
at the official issue tracker to request this support, and be sure to
151+
include the relevant information. Chances are the maintainers of this
151152
module do not have access to an unsupported compiler.
152153
153154
=head1 METHODS
@@ -157,15 +158,16 @@ module do not have access to an unsupported compiler.
157158
=item C<cflags>
158159
159160
Returns flag used by a supported compiler to enable OpenMP. If not support,
160-
an empty string is provided since by definition all OpenMP programs must compile
161-
because OpenMP pramgas are annotations hidden behind source code comments.
161+
an empty string is provided since by definition all OpenMP programs
162+
must compile because OpenMP pramgas are annotations hidden behind source
163+
code comments.
162164
163165
Example, GCC uses, C<-fopenmp>.
164166
165167
=item C<lddlflags>
166168
167-
Returns the flag used by the linker to enable OpenMP. This is usually the same
168-
as what is returned by C<cflags>.
169+
Returns the flag used by the linker to enable OpenMP. This is usually
170+
the same as what is returned by C<cflags>.
169171
170172
Example, GCC uses, C<-fopenmp>, for this as well.
171173
@@ -175,36 +177,33 @@ Used in support of L<Inline::C>'s C<with> method (inherited from
175177
L<Inline>). This method is not called directly, but used when compiling
176178
OpenMP programs with C<Inline::C>:
177179
178-
use Alien::OpenMP;
179-
use Inline (
180-
C => 'DATA',
181-
with => qw/Alien::OpenMP/,
180+
use Alien::OpenMP; use Inline (
181+
C => 'DATA', with => qw/Alien::OpenMP/,
182182
);
183183
184184
The nice, compact form above replaces this mess:
185185
186-
use Alien::OpenMP;
187-
use Inline (
188-
C => 'DATA',
189-
ccflagsex => Alien::OpenMP::cflags(),
190-
lddlflags => join( q{ }, $Config::Config{lddlflags}, Alien::OpenMP::lddlflags() ),
186+
use Alien::OpenMP; use Inline (
187+
C => 'DATA', ccflagsex => Alien::OpenMP::cflags(),
188+
lddlflags => join( q{ }, $Config::Config{lddlflags},
189+
Alien::OpenMP::lddlflags() ),
191190
);
192191
193192
=item C<_check_libs>
194193
195194
Internal method.
196195
197-
Returns an array reference of libraries, e.g., C<gomp> for C<gcc>. It is meant
198-
specifically as an internal method to support L<Devel::CheckLib> in this module's
199-
C<Makefile.PL>.
196+
Returns an array reference of libraries, e.g., C<gomp> for C<gcc>. It is
197+
meant specifically as an internal method to support L<Devel::CheckLib>
198+
in this module's C<Makefile.PL>.
200199
201200
=item C<_check_headers>
202201
203202
Internal method.
204203
205-
Returns an array reference of header files, e.g., C<omp.h> for C<gcc>. It is meant
206-
specifically as an internal method to support L<Devel::CheckLib> in this module's
207-
C<Makefile.PL>.
204+
Returns an array reference of header files, e.g., C<omp.h> for C<gcc>. It
205+
is meant specifically as an internal method to support L<Devel::CheckLib>
206+
in this module's C<Makefile.PL>.
208207
209208
=back
210209

0 commit comments

Comments
 (0)