Skip to content

Commit 870755e

Browse files
zbeekmanzbeekman
authored
Merge pull request #333 from sourceryinstitute/doc-cleanup
Update and cleanup markdown files
2 parents 793813d + 386f818 commit 870755e

File tree

11 files changed

+422
-38
lines changed

11 files changed

+422
-38
lines changed

‎.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ prerequisites/build text
3131
developer-scripts export-ignore
3232
codecov.yml export-ignore
3333
*.enc export-ignore
34+
.github

‎.github/ISSUE_TEMPLATE.md

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
<!-- Please fill out the issue template included below, failure to do -->
2+
<!-- so may result in immediate closure of your issue. -->
3+
4+
<!-- Fill out all portions of this template that apply. Please delete -->
5+
<!-- any unnecessary sections. -->
6+
7+
- [ ] I have surrounded any code, or log output in codeblock fences
8+
(` ``` `) if it occupies more than one line, or in single
9+
backticks if it is short `short code`
10+
11+
<!-- Long code goes in a fenced code block: -->
12+
<!-- ``` -->
13+
<!-- Line one of code output -->
14+
<!-- Line two of output -->
15+
<!-- etc. -->
16+
<!-- ``` -->
17+
18+
19+
# Question: #
20+
21+
<!-- delete this section if it does not apply -->
22+
The title of the issue should start with `Question:` followed by a
23+
succinct title. Add the text of your question here. Be specific. Search for
24+
answers on https://google.com and https://stackoverflow.com
25+
before asking a new question
26+
27+
# RFE: #
28+
29+
<!-- delete this section if it does not apply -->
30+
The title of the issue should start with `RFE:` followed by a succinct
31+
title. Add a description of your requested enhancement here. If you are
32+
willing to help out please also read the [Helping Out] section of
33+
[CONTRIBUTING.md]
34+
35+
36+
37+
# Defect/bug report #
38+
39+
<!-- delete this section if it does not apply -->
40+
The title of the issue should start with `Defect:` followed by a
41+
succinct title.
42+
43+
Please replace `[ ]` with `[X]` to indicate you have taken the requested action
44+
45+
- [ ] I have searched the [issues page] and [mailing list] and did
46+
not find any issue matching the one I would like to report
47+
- [ ] I have included a succinct description of the problem,
48+
including the steps necessary to reproduce it
49+
- [ ] I have included which version of OpenCoarrays I am working
50+
with, or the output of `git describe` if working with a cloned
51+
repository rather than an [official release]
52+
- [ ] I have included the MPI library name and version I am using
53+
with OpenCoarrays
54+
- [ ] name: [MPICH] version:
55+
- [ ] name: [Open-MPI] version:
56+
- [ ] name: [MVAPICH] version:
57+
- [ ] name: [MPT] version:
58+
- [ ] name: [Intel MPI] version:
59+
- [ ] other:
60+
<!-- delete all but the matching MPI implementation -->
61+
- [ ] I have included the Fortran compiler name and version that I am
62+
using with OpenCoarrays
63+
- [ ] I have included the output of `uname -a`
64+
- [ ] I have included the Operating system name and version,
65+
including linux distro
66+
- [ ] I have included the machine name if I am allowed to do so and
67+
wish to seek help debugging on that particular system (Titan,
68+
Pleiades, Excalibur, Lightening, Mira, etc.)
69+
70+
## Installation/build problem ##
71+
72+
<!-- delete this section if it does not apply -->
73+
74+
- [ ] I have attached a log of the attempted build/installation,
75+
changing the extension to `.txt` and uploaded it to this issue
76+
- [ ] I have indicated if previous versions of OpenCoarrays are or
77+
were installed on the machine in question
78+
<!-- please select one from the top level-->
79+
- [ ] Build/install was attempted with [install.sh]
80+
- [ ] I have attached the `install-opencoarrays.log` file
81+
after re-running the script with the debug flags `-d` and
82+
`-v` turned on (after renaming the log file to have a `.txt`
83+
extension)
84+
- [ ] Build/install was attempted with system package manager like
85+
[homebrew] (which one?)
86+
- [ ] Build/install was attempted with manual/advanced
87+
[CMake install]
88+
- [ ] Name and version of the C compiler being used
89+
- [ ] Name and version of the Fortran compiler being used
90+
- [ ] Attached/included the output of the configure step with
91+
CMake. (Usually something like `cd build && cmake ..`)
92+
- [ ] Attached/included the output of `make VERBOSE=1`
93+
- [ ] Attached/included the output of `ctest --verbose`
94+
- [ ] Other build/install was attempted (please describe)
95+
96+
Don't forget the description of the problem. The more details you give
97+
us, the faster, and more easily we can help you
98+
99+
## Compile time or run time error
100+
101+
<!-- delete this section if it does not apply -->
102+
103+
<!-- pick one of the first two -->
104+
- [ ] I am experiencing a compile time error (all gfortran ICEs
105+
should be reported to the [GFortran bug tracker]... You can post
106+
the ICE here too for tracking purposes, with a link to the
107+
GFortran problem report)
108+
- [ ] I am experiencing a runtime issue
109+
- [ ] I have included a minimally complete verifiable example (MCVE)
110+
that exhibits the problem and suitable for adding to regression
111+
tests (option, but you receive infinite karma
112+
for including this)
113+
114+
Description with as many details as possible to reproduce the problem.
115+
116+
117+
[links]:#
118+
[GFortran bug tracker]: https://gcc.gnu.org/bugzilla/
119+
[Intel MPI]: https://software.intel.com/en-us/intel-mpi-library
120+
[MPT]: http://www.sgi.com/products/software/sps.html
121+
[MVAPICH]: http://mvapich.cse.ohio-state.edu
122+
[MPICH]: https://www.mpich.org
123+
[Open-MPI]: https://www.open-mpi.org
124+
[CONTRIBUTING.md]: https://github.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.md
125+
[Helping Out]: https://github.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.md#helping-out
126+
[official release]: https://github.com/sourceryinstitute/opencoarrays/releases
127+
[CMake install]: https://github.com/sourceryinstitute/opencoarrays/blob/master/INSTALL.md#cmake-scripts
128+
[homebrew]: http://brew.sh
129+
[issues page]: https://github.com/sourceryinstitute/opencoarrays/issues
130+
[mailing list]: https://groups.google.com/forum/#!forum/opencoarrays
131+
[install.sh]: https://github.com/sourceryinstitute/opencoarrays/blob/master/install.sh

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!-- Please fill out the pull request template included below, failure -->
2+
<!-- to do so may result in immediate closure of your pull request. -->
3+
4+
<!-- Fill out all portions of this template that apply. Please delete -->
5+
<!-- any unnecessary sections. -->
6+
7+
This pull request (PR) is a:
8+
- [ ] Bug fix
9+
- [ ] Feature addition
10+
- [ ] Other, Please describe:
11+
12+
I certify that:
13+
14+
- [ ] I have reviewed the [contributing guidelines]
15+
- [ ] If this PR is a work in progress I have added `WIP:` to the
16+
beginning of the PR title
17+
- [ ] If this PR is problematic for any reason, I have added
18+
`DO NOT MERGE:` to the beginning of the title
19+
- [ ] The branch name and title of this PR contains the text
20+
`issue-<#>` where `<#>` is replaced by the issue that this PR
21+
is addressing
22+
- [ ] I have deleted trailing white space on any lines that this PR
23+
touches
24+
- [ ] I have used spaces for indentation on any lines that this PR
25+
touches
26+
- [ ] I have included some comments to explain non-obvious code
27+
changes
28+
- [ ] I have run the tests localy (`ctest`) and all tests pass
29+
- [ ] Each commit is a logically atomic, self-consistent, cohesive
30+
set of changes
31+
- [ ] The [commit message] should follow [these guidelines]:
32+
- [ ] First line is directive phrase, starting with a capitalized
33+
imperative verb, and is no longer than 50 characters
34+
summarizing your commit
35+
- [ ] Next line, if necessary is blank
36+
- [ ] Following lines are all wrapped at 72 characters and can
37+
include additional paragraphs, bulleted lists, etc.
38+
- [ ] Use [Github keywords] where appropriate, to indicate the
39+
commit resolves an open issue.
40+
- [ ] I have signed [Contributor License Agreement (CLA)] by
41+
clicking the "details" link to the right of the `licence/cla`
42+
check and following the directions on the CLA assistant webpage
43+
44+
## Summary of changes ##
45+
46+
Summarize what you changed
47+
48+
## Rationale for changes ##
49+
50+
Why did you make these changes?
51+
52+
## For contributors and SI team members with code review priviledges ##
53+
54+
- [ ] I certify that I will wait 24 hours before self-approving via
55+
[pullapprove comment] or [Github code review] so that someone
56+
else has the chance to review my proposed changes
57+
58+
[links]:#
59+
[contributing guidelines]: https://github.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.md
60+
[commit message]: https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message
61+
[these guidelines]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
62+
[Contributor License Agreement (CLA)]: https://cla-assistant.io/sourceryinstitute/opencoarrays
63+
[pullapprove comment]: https://pullapprove.com/sourceryinstitute/opencoarrays/settings/
64+
[Github code review]: https://help.github.com/articles/about-pull-request-reviews/
65+
[Github keywords]: https://help.github.com/articles/closing-issues-via-commit-messages/

‎AUTHORS.md

Lines changed: 86 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,97 @@
1+
<a name="top"> </a>
2+
3+
4+
[This document is formatted with GitHub-Flavored Markdown. ]:#
5+
[For better viewing, including hyperlinks, read it online at ]:#
6+
[https://github.com/sourceryinstitute/opencoarrays/blob/master/AUTHORS.md]:#
7+
18
Contributors to OpenCoarrays
29
============================
310

11+
[![CLA assistant][CLA img]](https://cla-assistant.io/sourceryinstitute/opencoarrays)
412
[![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/AUTHORS.pdf)
513

614
Download this file as a PDF document
7-
[here](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/AUTHORS.pdf).
15+
[here][pdfloc].
16+
17+
- [X] Alessandro Fanfarillo <[email protected]>
18+
- [X] Damian Rouson <[email protected]>
19+
- [X] Izaak "Zaak" Beekman <https://izaakbeekman.com> [@zbeekman](https://twitter.com/zbeekman)
20+
- [X] Tobias Burnus <[email protected]>
21+
- [X] Andre Vehreschild <[email protected]>
22+
- [X] Craig Rasmussen <[email protected]>
23+
- [X] Jeff Hammond <[email protected]>
24+
- [ ] Salvatore Filippone <[email protected]>
25+
- [ ] Raul Laasner <[email protected]>
26+
- [X] Naveen Ravi <[email protected]>
27+
- [X] Soren Rasmussen <[email protected]>
28+
- [X] LaHaine <[email protected]>
29+
- [ ] John C. Linford <[email protected]>
30+
- [ ] Götz Waschk <[email protected]>
31+
- [ ] Daniel Carrera <[email protected]>
32+
33+
[top]
34+
35+
Linux Foundation Contributor License Agreement (CLA)
36+
----------------------------------------------------
37+
38+
All contributors are expected to sign the [Linux Foundation Contributor
39+
License Agreement (CLA), the "Developer Certificate of Origin",
40+
Version 1.1.](https://gist.github.com/zbeekman/0a5d60a1cbd1f6a8cfa5)
41+
using the [CLA-Assistant]
42+
43+
```
44+
Developer Certificate of Origin
45+
Version 1.1
46+
47+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
48+
660 York Street, Suite 102,
49+
San Francisco, CA 94110 USA
50+
51+
Everyone is permitted to copy and distribute verbatim copies of this
52+
license document, but changing it is not allowed.
53+
54+
55+
Developer's Certificate of Origin 1.1
56+
57+
By making a contribution to this project, I certify that:
58+
59+
(a) The contribution was created in whole or in part by me and I
60+
have the right to submit it under the open source license
61+
indicated in the file; or
62+
63+
(b) The contribution is based upon previous work that, to the best
64+
of my knowledge, is covered under an appropriate open source
65+
license and I have the right under that license to submit that
66+
work with modifications, whether created in whole or in part
67+
by me, under the same open source license (unless I am
68+
permitted to submit under a different license), as indicated
69+
in the file; or
70+
71+
(c) The contribution was provided directly to me by some other
72+
person who certified (a), (b) or (c) and I have not modified
73+
it.
74+
75+
(d) I understand and agree that this project and the contribution
76+
are public and that a record of the contribution (including all
77+
personal information I submit with it, including my sign-off) is
78+
maintained indefinitely and may be redistributed consistent with
79+
this project or the open source license(s) involved.
80+
```
81+
82+
[top]
883

9-
- Alessandro Fanfarillo <[email protected]>
10-
- Damian Rouson <[email protected]>
11-
- Izaak Beekman <http://izaakbeekman.com>
12-
- Daniel Carrera <[email protected]>
13-
- Jeff Hammond <[email protected]>
14-
- Tobias Burnus <[email protected]>
84+
---
1585

16-
[I think we're missing a number of people here]:#
17-
[@naveen-rn?]:#
18-
[@raul-nasner?]:#
19-
[Others:]:#
86+
[![GitHub forks](https://img.shields.io/github/forks/sourceryinstitute/opencoarrays.svg?style=social&label=Fork)](https://github.com/sourceryinstitute/opencoarrays/fork)
87+
[![GitHub stars](https://img.shields.io/github/stars/sourceryinstitute/opencoarrays.svg?style=social&label=Star)](https://github.com/sourceryinstitute/opencoarrays)
88+
[![GitHub watchers](https://img.shields.io/github/watchers/sourceryinstitute/opencoarrays.svg?style=social&label=Watch)](https://github.com/sourceryinstitute/opencoarrays)
89+
[![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?hashtags=HPC,Fortran,PGAS&related=zbeekman,gnutools,HPCwire,HPC_Guru,hpcprogrammer,SciNetHPC,DegenerateConic,jeffdotscience,travisci&text=Stop%20programming%20w%2F%20the%20%23MPI%20docs%20in%20your%20lap%2C%20try%20Coarray%20Fortran%20w%2F%20OpenCoarrays%20%26%20GFortran!&url=https%3A//github.com/sourceryinstitute/opencoarrays)
2090

2191
[Links]:#
2292
[pdf img]: https://img.shields.io/badge/PDF-AUTHORS.md-6C2DC7.svg?style=flat-square "Download as PDF"
93+
[contributor img]: https://img.shields.io/github/contributors/sourceryinstitute/opencoarrays.svg?style=flat-square "Contributors"
94+
[CLA img]: https://cla-assistant.io/readme/badge/sourceryinstitute/opencoarrays "CLA signees"
95+
[pdfloc]: http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/AUTHORS.pdf "Get this file as a PDF document"
96+
[CLA-Assistant]: https://cla-assistant.io/sourceryinstitute/opencoarrays "CLA-Assistant"
97+
[top]: #top

‎Brewfile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@
1010
# Once Homebrew/Linuxbrew is installed, execute the following commands to install the required prerequisites:
1111
# `brew tap homebrew/bundle && brew bundle`
1212
#
13-
# NOTE: Until Linuxbrew upgrades to GCC 6.1 or later, you will have to edit the `mpich` line to:
14-
# `brew 'mpich', args: ['cc=gcc-5', 'cxx=g++-5']`
1513

1614
brew 'cmake'
1715
brew 'gcc'
1816
brew 'mpich', args: ['cc=gcc-6', 'cxx=g++-6']
17+
brew 'opencoarrays'
1918

2019
# [Homebrew]: http://brew.sh
2120
# [Linuxbrew]: http://linuxbrew.sh

‎CAF_ABI.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ standard-conforming Fortran 2008 or 2015 and compile their code with the OpenCoa
2424
The actual function names in this document have a PREFIX in the source code to avoid
2525
name clashes. The prefix can be vendor-specific.
2626

27+
### Warning ###
28+
29+
*This document may be out of date.*
30+
2731
To Do
2832
-----
2933

@@ -560,6 +564,14 @@ __GCC__:
560564
__TODO__:
561565
Change `errmsg_len` to `size_t`
562566

567+
---
568+
569+
[![GitHub forks](https://img.shields.io/github/forks/sourceryinstitute/opencoarrays.svg?style=social&label=Fork)](https://github.com/sourceryinstitute/opencoarrays/fork)
570+
[![GitHub stars](https://img.shields.io/github/stars/sourceryinstitute/opencoarrays.svg?style=social&label=Star)](https://github.com/sourceryinstitute/opencoarrays)
571+
[![GitHub watchers](https://img.shields.io/github/watchers/sourceryinstitute/opencoarrays.svg?style=social&label=Watch)](https://github.com/sourceryinstitute/opencoarrays)
572+
[![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?hashtags=HPC,Fortran,PGAS&related=zbeekman,gnutools,HPCwire,HPC_Guru,hpcprogrammer,SciNetHPC,DegenerateConic,jeffdotscience,travisci&text=Stop%20programming%20w%2F%20the%20%23MPI%20docs%20in%20your%20lap%2C%20try%20Coarray%20Fortran%20w%2F%20OpenCoarrays%20%26%20GFortran!&url=https%3A//github.com/sourceryinstitute/opencoarrays)
573+
574+
563575
[Hyperlinks]:#
564576

565577
[TS29113]: ftp://ftp.nag.co.uk/sc22wg5/n1901-n1950/n1942.pdf

‎CONTRIBUTING.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,12 @@ If you encounter problems during the course of [Installing] OpenCoarrays or [usi
3333
- Number of MPI ranks/processing elements/coarray images being run on
3434
- How the code was compiled, including all flags and commands
3535
- Minimal reproducer code (a few lines) required to trigger the bug
36-
4. Any help you can provide diagnosing, isolating and fixing the problem is appreciated! Please see the [helping out] section for more information.
36+
4. Any help you can provide diagnosing, isolating and fixing the
37+
problem is appreciated! Please see the [helping out] section for
38+
more information.
39+
40+
An [issue template] is in the `.github` folder to help ensure
41+
compliance, and adequate information is provided.
3742

3843
Requesting Enhancements
3944
-----------------------
@@ -66,7 +71,7 @@ Here is a checklist to help you get started contributing to OpenCoarrays and wal
6671
- [ ] Next line, if necessary is blank
6772
- [ ] Following lines are all wrapped at 72 characters and can include additional paragraphs, bulleted lists, etc.
6873
- [ ] Use [Github keywords] where appropriate, to indicate the commit resolves an open issue.
69-
- [ ] Please do you best to keep a [clean and coherent history]. `git add -p ...`, `git commit --amend` and `git rebase --interactive <root-ref>` can be helpful to rework your commits into a cleaner, clearer state.
74+
- [ ] Please do your best to keep a [clean and coherent history]. `git add -p ...`, `git commit --amend` and `git rebase --interactive <root-ref>` can be helpful to rework your commits into a cleaner, clearer state.
7075
- [ ] Next, [open up a pull request] where the base branch is [`master`] or [`devel`] as appropriate
7176
- [ ] Please be patient and responsive to requests and comments from SourceryInstitute (SI) team members. You may be asked to amend or otherwise alter commits, or push new commits to your branch.
7277
- [ ] Make sure that all the automated [Travis-CI tests] pass
@@ -86,6 +91,14 @@ The `master` branch should remain in pristine, stable condition all of the time.
8691

8792
This is the development branch, akin to GCC's `trunk`. Both of `devel` and `master` branches are protected, but `devel` will eventually be merged into `master` when the next major release happens, but until then it is a stable, forward looking branch where experimental features and major changes or enhancements may be applied and tested. Just as with `master` all changes are applied atomically as pull requests.
8893

94+
---
95+
96+
[![GitHub forks](https://img.shields.io/github/forks/sourceryinstitute/opencoarrays.svg?style=social&label=Fork)](https://github.com/sourceryinstitute/opencoarrays/fork)
97+
[![GitHub stars](https://img.shields.io/github/stars/sourceryinstitute/opencoarrays.svg?style=social&label=Star)](https://github.com/sourceryinstitute/opencoarrays)
98+
[![GitHub watchers](https://img.shields.io/github/watchers/sourceryinstitute/opencoarrays.svg?style=social&label=Watch)](https://github.com/sourceryinstitute/opencoarrays)
99+
[![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?hashtags=HPC,Fortran,PGAS&related=zbeekman,gnutools,HPCwire,HPC_Guru,hpcprogrammer,SciNetHPC,DegenerateConic,jeffdotscience,travisci&text=Stop%20programming%20w%2F%20the%20%23MPI%20docs%20in%20your%20lap%2C%20try%20Coarray%20Fortran%20w%2F%20OpenCoarrays%20%26%20GFortran!&url=https%3A//github.com/sourceryinstitute/opencoarrays)
100+
101+
89102
[Links]: #
90103
[video]: https://youtu.be/EwWZbyjDs9c?list=PLg7s6cbtAD17uAwaZwiykDci_q3te3CTY
91104
[a number of resources]: http://scottchacon.com/2011/08/31/github-flow.html

0 commit comments

Comments
 (0)