[d] Add README for process contributing to dmd and phobos

Message ID CABOHX+eKs_ubSDp8ERzcZdiXtc39BW+TZS9hwRD7xTKukYz3vw@mail.gmail.com
State New
Headers show
Series
  • [d] Add README for process contributing to dmd and phobos
Related show

Commit Message

Iain Buclaw Jan. 10, 2019, 12:23 p.m.
Hi,

Joseph made mention that there isn't a readme documenting where
changes to d/dmd, libphobos/libdruntime, and libphobos/src should go.

I hope this clears things up.  OK for trunk?

-- 
Iain
---
gcc/d/ChangeLog:

2019-01-10  Iain Buclaw  <ibuclaw@gdcproject.org>

    * README.gcc: New file.

libphobos/ChangeLog:

2019-01-10  Iain Buclaw  <ibuclaw@gdcproject.org>

    * README.gcc: New file.

---

Comments

Joseph Myers Jan. 10, 2019, 5:26 p.m. | #1
On Thu, 10 Jan 2019, Iain Buclaw wrote:

> Hi,

> 

> Joseph made mention that there isn't a readme documenting where

> changes to d/dmd, libphobos/libdruntime, and libphobos/src should go.

> 

> I hope this clears things up.  OK for trunk?


This sort of patch is clearly covered by D maintainership.

-- 
Joseph S. Myers
joseph@codesourcery.com
Iain Buclaw Jan. 12, 2019, 9:08 p.m. | #2
On Thu, 10 Jan 2019 at 18:26, Joseph Myers <joseph@codesourcery.com> wrote:
>

> On Thu, 10 Jan 2019, Iain Buclaw wrote:

>

> > Hi,

> >

> > Joseph made mention that there isn't a readme documenting where

> > changes to d/dmd, libphobos/libdruntime, and libphobos/src should go.

> >

> > I hope this clears things up.  OK for trunk?

>

> This sort of patch is clearly covered by D maintainership.

>


OK. Thought it best to wait before committing, as the content is not
meant for myself to understand.

-- 
Iain

Patch

diff --git a/gcc/d/README.gcc b/gcc/d/README.gcc
new file mode 100644
index 00000000000..757545cc705
--- /dev/null
+++ b/gcc/d/README.gcc
@@ -0,0 +1,11 @@ 
+The files in the dmd subdirectory are part of the front-end for the
+Digital Mars D compiler, hosted at https://github.com/dlang/dmd/.
+
+They cover the lexical analysis, parsing, and semantic analysis of the
+D Programming Language defined in the documents at https://dlang.org/.
+
+To report a problem or look up known issues with the dmd front-end,
+please visit the issue tracker at https://issues.dlang.org/.
+
+All changes to dmd should go through the upstream repository first,
+then merged back to GCC.
diff --git a/libphobos/README.gcc b/libphobos/README.gcc
new file mode 100644
index 00000000000..53593783995
--- /dev/null
+++ b/libphobos/README.gcc
@@ -0,0 +1,26 @@ 
+The files in this directory where noted are part of the DRuntime
+and Phobos library.
+
+DRuntime is the low-level runtime library backing the D programming
+language, hosted at https://github.com/dlang/druntime/.
+
+Phobos is the standard library for the D Programming Language, hosted
+at https://github.com/dlang/phobos/.
+
+The following sources and directories are part of DRuntime:
+  libdruntime/core/
+  libdruntime/gc/
+  libdruntime/gcstub/
+  libdruntime/object.d
+  libdruntime/rt/
+
+The following sources and directories are part of Phobos:
+  src/etc/
+  src/index.d
+  src/std/
+
+To report a bug or look up known issues with the runtime or standard
+library please visit the issue tracker at https://issues.dlang.org/.
+
+All changes to either of these libraries should go through the
+upstream repository first, then merged back to GCC.