Skip to content

Commit e54cdf1

Browse files
authored
Merge pull request metacpan#753 from metacpan/tsibley/document-status-field
Indexing doc: Describe release.status and file.status
2 parents 5518ff3 + 524b9a3 commit e54cdf1

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/indexing.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,15 @@ Defaults to true. Set to false by MetaCPAN::Script::Release if any of the
104104
Modules (via Files) in the Release are marked unauthorized but indexed.
105105

106106

107+
### release.status and file.status
108+
109+
Release status is "cpan" by default. When a file is deleted, its status
110+
changes to "backpan". MetaCPAN::Script::Latest is in charge of marking
111+
Releases as "latest" when they're in PAUSE's 02packages file (and demoting
112+
previous "latest" Releases back to "cpan"). The status field of Files is just
113+
a copy of their Release's status (I **think**).
114+
115+
107116

108117
## Notes on timing/ordering
109118

0 commit comments

Comments
 (0)