Skip to content

Commit ee172ee

Browse files
timgimyeemohawk2
authored andcommitted
Document exportable functions, constants and :tags
1 parent 186caee commit ee172ee

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

Changes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{{$NEXT}}
22
- add AppVeyor CI
33
- Add PERMS options to create temp file with given file permissions
4+
- Document exportable functions, constants and :tags
45

56
0.2309 2019-01-06 20:29:15Z
67
- fix longstanding pod formatting error (issue #19, RT#109526)

lib/File/Temp.pm

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2333,6 +2333,56 @@ Current API available since 0.15.
23332333
23342334
=back
23352335
2336+
=head1 EXPORTS
2337+
2338+
These functions are not exported by default but may be exported
2339+
individually:
2340+
2341+
tempfile
2342+
tempdir
2343+
unlink0
2344+
cleanup
2345+
2346+
The functions and constants in these export tags are exported by
2347+
default:
2348+
2349+
=over
2350+
2351+
=item :POSIX
2352+
2353+
Exports the L<POSIX functions|"POSIX FUNCTIONS">:
2354+
2355+
tmpnam
2356+
tmpfile
2357+
2358+
=item :mktemp
2359+
2360+
Exports the L<mktemp functions|"MKTEMP FUNCTIONS">:
2361+
2362+
mktemp
2363+
mkstemp
2364+
mkstemps
2365+
mkdtemp
2366+
2367+
=item :seekable
2368+
2369+
Exports the seek constants:
2370+
2371+
SEEK_SET
2372+
SEEK_CUR
2373+
SEEK_END
2374+
2375+
=back
2376+
2377+
So these two are equivalent:
2378+
2379+
use File::Temp;
2380+
use File::Temp qw/ :POSIX :mktemp :seekable /;
2381+
2382+
Use an empty list to export nothing:
2383+
2384+
use File::Temp ();
2385+
23362386
=head1 PACKAGE VARIABLES
23372387
23382388
These functions control the global state of the package.

0 commit comments

Comments
 (0)