Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .github/workflows/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,20 @@ jobs:
name: markdownlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: DavidAnson/markdownlint-cli2-action@v14
- uses: actions/checkout@v4
- uses: DavidAnson/markdownlint-cli2-action@v17
with:
config: 'eep.markdownlint.json'
globs: |
README.md
eeps/*.md
- name: Build html using Gruber MD
run: |
./build.pl
## Check for warnings by build.pl
if grep '<h2>Warnings</h2>' > /dev/null; then
exit 1
fi
- name: Deploy on erlang.org
if: github.ref == 'refs/heads/master'
env:
Expand Down
53 changes: 44 additions & 9 deletions eep-index.pl
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
'Draft' => '',
'Accepted' => 'A',
'Rejected' => 'R',
'Withdrawn' => 'W',
'Replaced' => 'P',
'Deferred' => 'D',
'Final' => 'F',
);
Expand Down Expand Up @@ -164,7 +164,7 @@ sub set_author {
}

sub set_status {
m|^ ([^/]*) (/? [^\s]*) \s* (.*)|x;
m|^ ([^/]*) (/? [^\s]*) \s* ([^;]*)|x;
my ($status, $tag, $desc) = ($1, $2, $3);
my $s = $status_map{lc $status};
unless (defined $s) {
Expand Down Expand Up @@ -196,7 +196,7 @@ sub set_type {
}

# Mapping of EEP header tag to handler set_* function
my %key =
my %set =
('eep' => \&set_eep,
'title' => \&set_title,
'version' => 0,
Expand All @@ -214,14 +214,43 @@ sub set_type {
'replaced-by' => 0,
);

sub check_erlang_version {
my $version = $_;
if (defined($version)) {
push @warnings, "File $file: 'version: $version' illegal!"
unless $version =~ /OTP_R[0-9]+[AB]([-][0-9])?/ || $version =~ /OTP-([0-9]+)[.]/;
} elsif ($status{$file} =~ /^F\//) {
push @warnings, "File $file: 'version: EEPs in status Final must have an Erlang-Version!";
}
}

# Mapping of EEP header tag to handler check_* function
my %check =
('eep' => 0,
'title' => 0,
'version' => 0,
'last-modified' => 0,
'author' => 0,
'discussions-to' => 0,
'status' => 0,
'type' => 0,
'content-type' => 0,
'requires' => 0,
'created' => 0,
'erlang-version' => \&check_erlang_version,
'post-history' => 0,
'replaces' => 0,
'replaced-by' => 0,
);

sub store_key {
my ($hash, $key, $value) = @_;
unless (defined $key{$key}) {
unless (defined $set{$key}) {
push
@warnings,
"File $file: '$key:' unknown header - file skipped!";
}
if ($key{$key}) {
if ($set{$key} || $check{$key}) {
if (defined $$hash{$key}) {
push
@warnings,
Expand Down Expand Up @@ -286,8 +315,8 @@ sub store_key {
} elsif ($line =~ m|^\s*$|) { # blank line
# end of headers - process them all
next LINE unless defined($hdr{'eep'}); # still missing?
foreach (keys %key) {
if ($key{$_} and !(defined $hdr{$_})) {
foreach (keys %set) {
if ($set{$_} and !(defined $hdr{$_})) {
push
@warnings,
"File $file: '$_:' missing header - file skipped!";
Expand All @@ -296,8 +325,14 @@ sub store_key {
}
# call handler for all headers
while (($key, $_) = each %hdr) {
&{$key{$key}};
&{$set{$key}} if $set{$key};
}

# call checks for all headers
while (($key, $_) = each %hdr) {
&{$check{$key}} if $check{$key};
}

last LINE;
} else {
push
Expand Down Expand Up @@ -369,7 +404,7 @@ sub table {
#
if (@warnings) {
print "${lf}${lf}${lf}----${lf}Warnings${lf}--------${lf}";
foreach (@warnings) {
foreach (sort @warnings) {
print " $_";
}
}
5 changes: 3 additions & 2 deletions eeps/eep-0001.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,9 @@ versions of the EEP are posted to erlang-questions. Both headers
should be in dd-mmm-yyyy format, e.g. 14-Aug-2009.

Standards Track EEPs must have a Erlang-Version header which indicates
the version of Erlang that the feature will be released with. Process
EEPs do not need a Erlang-Version header.
the version of Erlang that the feature will or has be released with.
Process EEPs do not need a Erlang-Version header. The version must be
in the same format as the git tag scheme of Erlang/OTP project.

EEPs may have a Requires header, indicating the EEP numbers that this
EEP depends on..
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0004.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Status: Final/R12B-0 Proposal is implemented in OTP release R12B-0
Type: Standards Track
Created: 10-Aug-2007
Erlang-Version: R12B-0
Erlang-Version: OTP_R12B-0
Post-History:
****
EEP 4: New BIFs for bit-level binaries (bit strings)
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0005.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Status: Draft
Type: Standards Track
Created: 10-Aug-2007
Erlang-Version: R12B-0
Erlang-Version: OTP_R12B-0
Post-History:
****
EEP 5: More Versatile Encapsulation with `export_to`
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0006.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Status: Final/R12B-0 Proposal is implemented in OTP release R12B-0
Type: Standards Track
Created: 10-Aug-2007
Erlang-Version: R12B-0
Erlang-Version: OTP_R12B-0
Post-History:
****
EEP 6: New BIFs for tuple and binary sizes
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0007.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Status: Rejected
Type: Standards Track
Created: 3-Sep-2007
Erlang-Version: R12B
Erlang-Version: OTP_R12B
Post-History:
****
EEP 7: Foreign Function Interface (FFI)
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0008.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Status: Final/R13B03 Proposal documented and implemented in OTP R13B03
Type: Standards Track
Created: 2-Dec-2007
Erlang-Version: R12B
Erlang-Version: OTP_R12B
Post-History:
****
EEP 8: Types and function specifications
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0009.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Status: Final/R-34 Replaced with EEP-11 and EEP-31 except `binary_string` which is part of a new `string` implementation
Type: Standards Track
Created: 28-Dec-2007
Erlang-Version: R12B-2
Erlang-Version: OTP_R12B-2
Post-History:
****
EEP 9: Library for working with binaries
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0010.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Status: Draft
Type: Standards Track
Created: 07-may-2008
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Post-History: 01-jan-1970
****
EEP 10: Representing Unicode characters in Erlang
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0011.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
except for Unicode support according to EEP 10
Type: Standards Track
Created: 04-Jun-2008
Erlang-Version: R12B-5
Erlang-Version: OTP_R12B-5
Post-History: 01-Jan-1970
****
EEP 11: Built in regular expressions in Erlang
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0012.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Status: Draft
Type: Standards Track
Created: 10-Jul-2008
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Post-History:
****
EEP 12: Extensions to comprehensions
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0013.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 09-Jul-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0014.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 10-Jul-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0015.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 15-Jul-2008
Post-History:
****
Expand Down
11 changes: 6 additions & 5 deletions eeps/eep-0016.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 23-Jul-2008
Post-History:
****
Expand Down Expand Up @@ -181,12 +181,13 @@ it would be easier to add this than to write it up.

Here's some text to go in the documentation:

<!-- markdownlint-disable MD027 -->
> is_integer(Term, LB, UB) -> bool()
>
>
> Types:
> Term = term()
> LB = integer()
> UB = integer()
> Term = term()
> LB = integer()
> UB = integer()
>
> Returns true if Term is an integer lying between LB
> and UB inclusive (LB =< Term, Term =< UB); otherwise
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0017.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 23-Jul-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0018.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Replaced
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 28-Jul-2008
Post-History:
Replaced-By: EEP-0068
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0019.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 14-Aug-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0020.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 05-Aug-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0021.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 08-Aug-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0022.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 27-Aug-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0023.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Final/R12B-4 Implemented in OTP release R12B-4
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 08-Aug-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0024.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Final/R12B-5 Implemented in OTP release R12B-5
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 22-Sep-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0025.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 28-Nov-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0026.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Björn Gustavsson <bjorn(at)erlang(dot)org>
Status: Accepted/R13A Implemented in OTP release R13A
Type: Standards Track
Erlang-Version: R12B-5
Erlang-Version: OTP_R12B-5
Created: 28-Jan-2009
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0028.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 08-Aug-2008
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0029.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Draft
Type: Standards Track
Erlang-Version: R12B-5
Erlang-Version: OTP_R12B-5
Created: 25-Feb-2009
Post-History:
****
Expand Down
2 changes: 1 addition & 1 deletion eeps/eep-0030.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Author: Richard A. O'Keefe <ok(at)cs(dot)otago(dot)ac(dot)nz>
Status: Final/R13A/R14A Implemented in OTP release R13A and R14A
Type: Standards Track
Erlang-Version: R12B-4
Erlang-Version: OTP_R12B-4
Created: 10-Jul-2008
Post-History:
****
Expand Down
Loading