You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by lu...@apache.org on 2014/10/06 22:03:28 UTC

[1/2] git commit: Updated developers documentation after migration to Git.

Repository: commons-math
Updated Branches:
  refs/heads/master 026af89ce -> e99b9ef25


Updated developers documentation after migration to Git.

Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/58ecf6b9
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/58ecf6b9
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/58ecf6b9

Branch: refs/heads/master
Commit: 58ecf6b9543e0b5edc2bef8c4f4b4965d0a70f24
Parents: 026af89
Author: Luc Maisonobe <lu...@apache.org>
Authored: Mon Oct 6 14:22:00 2014 +0200
Committer: Luc Maisonobe <lu...@apache.org>
Committed: Mon Oct 6 14:25:09 2014 +0200

----------------------------------------------------------------------
 src/site/xdoc/developers.xml | 28 ++++++++++++++++------------
 1 file changed, 16 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-math/blob/58ecf6b9/src/site/xdoc/developers.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index 825fc22..d74595b 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -47,14 +47,14 @@
             founded.
         </li>
         <li>Download the Commons Math source code.  Follow the instructions
-        under the heading "Anonymous Subversion" on the
-        <a href="http://www.apache.org/dev/version-control.html">Apache version
-         control page</a>  (Also have a look at the 
-        <a href="http://wiki.apache.org/commons/UsingSVN">Commons wiki
-        svn page </a>) to check out the Commons Math code base from Subversion.
-        The svn url for the current development sources of Commons Math
-        is 
-<source>https://svn.apache.org/repos/asf/commons/proper/math/trunk</source>
+        under the heading "Repository Checkout" on the
+        <a href="https://git-wip-us.apache.org/">Git at the ASF page</a>.
+        The git url for the current development sources of Commons Math
+        is <source>http://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
+        for anonymous read-only access and
+        <source>https://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
+        (where apacheid should be replaced by each committer Apache ID) for committers
+        read-write access.
         </li>
         <li>Like most commons components, Commons Math uses Apache Maven as our
             build tool. The sources can also be built using Ant (a working 
@@ -152,10 +152,14 @@
      Please make sure to set your IDE or editor to use spaces instead of tabs.
     </p>
     <p>
-      Committers should make sure that svn properties are correctly set on
-      files added to the repository.  See the section on Committer Subversion
-      Access on the <a href="http://www.apache.org/dev/version-control.html">
-      Apache Source Code Repositories</a> page.
+     Committers should configure the <source>user.name</source>,
+     <source>user.email</source> and <source>core.autocrlf</source>
+     git repository or global options with <source>git config</source>.
+     The first two options set the identity and mail of the committer.
+     The third option deals with line endings to achieve consistency
+     in line endings. Windows users should configure this option to
+     <source>true</source> while OS X and Linux users should configure
+     it to <source>input</source>.
     </p>
    </subsection>
    <subsection name='Documentation'>


[2/2] git commit: Typo.

Posted by lu...@apache.org.
Typo.

Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/e99b9ef2
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/e99b9ef2
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/e99b9ef2

Branch: refs/heads/master
Commit: e99b9ef254add2bdedda26714ab5944393cdd1b5
Parents: 58ecf6b
Author: Luc Maisonobe <lu...@apache.org>
Authored: Mon Oct 6 14:27:21 2014 +0200
Committer: Luc Maisonobe <lu...@apache.org>
Committed: Mon Oct 6 14:27:21 2014 +0200

----------------------------------------------------------------------
 src/site/xdoc/developers.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-math/blob/e99b9ef2/src/site/xdoc/developers.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index d74595b..7db17fe 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -180,7 +180,7 @@
       the expression to be formatted with either &#92;( and &#92;) for inline
       formulas, or &#92;[ and &#92;] to have the formula appear on a separate line.
       For example, &#92;(a^2 + b^2 = c^2&#92;) will render an in-line formula
-      saying thqt (a, b, c) is Pythagorean triplet.  Using &#92;[ and &#92;] on
+      saying that (a, b, c) is Pythagorean triplet.  Using &#92;[ and &#92;] on
       the ends will render the same formula on a separate line.  See the MathJax
       and LaTex documentation for details on how to represent formulas and
       escape special characters.</li>


Re: [Math] Apache/Git question (Was: [1/2] git commit: Updated developers documentation [...])

Posted by Gilles <gi...@harfang.homelinux.org>.
On Tue, 07 Oct 2014 15:17:27 +0200, luc wrote:

Thanks for the explanations.

Gilles

>
> Le 2014-10-07 12:12, Gilles a écrit :
>> Hello Luc.
>> On Mon, 06 Oct 2014 20:03:28 -0000, luc@apache.org wrote:
>>> Repository: commons-math
>>> Updated Branches:
>>>   refs/heads/master 026af89ce -> e99b9ef25
>>>
>>> Updated developers documentation after migration to Git.
>>> Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
>>> Commit: 
>>> http://git-wip-us.apache.org/repos/asf/commons-math/commit/58ecf6b9
>>> Tree: 
>>> http://git-wip-us.apache.org/repos/asf/commons-math/tree/58ecf6b9
>>> Diff: 
>>> http://git-wip-us.apache.org/repos/asf/commons-math/diff/58ecf6b9
>>> Branch: refs/heads/master
>>> Commit: 58ecf6b9543e0b5edc2bef8c4f4b4965d0a70f24
>>> Parents: 026af89
>>> Author: Luc Maisonobe <lu...@apache.org>
>>> Authored: Mon Oct 6 14:22:00 2014 +0200
>>> Committer: Luc Maisonobe <lu...@apache.org>
>>> Committed: Mon Oct 6 14:25:09 2014 +0200
>>>
>>> 
>>> ----------------------------------------------------------------------
>>>  src/site/xdoc/developers.xml | 28 ++++++++++++++++------------
>>>  1 file changed, 16 insertions(+), 12 deletions(-)
>>> 
>>> ----------------------------------------------------------------------
>>>
>>>
>>> 
>>> http://git-wip-us.apache.org/repos/asf/commons-math/blob/58ecf6b9/src/site/xdoc/developers.xml
>>> 
>>> ----------------------------------------------------------------------
>>> diff --git a/src/site/xdoc/developers.xml 
>>> b/src/site/xdoc/developers.xml
>>> index 825fc22..d74595b 100644
>>> --- a/src/site/xdoc/developers.xml
>>> +++ b/src/site/xdoc/developers.xml
>>> @@ -47,14 +47,14 @@
>>>              founded.
>>>          </li>
>>>          <li>Download the Commons Math source code.  Follow the 
>>> instructions
>>> -        under the heading "Anonymous Subversion" on the
>>> -        <a 
>>> href="http://www.apache.org/dev/version-control.html">Apache version
>>> -         control page</a>  (Also have a look at the
>>> -        <a href="http://wiki.apache.org/commons/UsingSVN">Commons 
>>> wiki
>>> -        svn page </a>) to check out the Commons Math code base 
>>> from Subversion.
>>> -        The svn url for the current development sources of Commons 
>>> Math
>>> -        is
>>> 
>>> -<source>https://svn.apache.org/repos/asf/commons/proper/math/trunk</source>
>>> +        under the heading "Repository Checkout" on the
>>> +        <a href="https://git-wip-us.apache.org/">Git at the ASF 
>>> page</a>.
>>> +        The git url for the current development sources of Commons 
>>> Math
>>> +        is 
>>> <source>http://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
>>> +        for anonymous read-only access and
>>> +        
>>> <source>https://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
>>> +        (where apacheid should be replaced by each committer 
>>> Apache ID) for committers
>>> +        read-write access.
>>>          </li>
>>>          <li>Like most commons components, Commons Math uses Apache
>>> Maven as our
>>>              build tool. The sources can also be built using Ant (a 
>>> working
>>> @@ -152,10 +152,14 @@
>>>       Please make sure to set your IDE or editor to use spaces
>>> instead of tabs.
>>>      </p>
>>>      <p>
>>> -      Committers should make sure that svn properties are 
>>> correctly set on
>>> -      files added to the repository.  See the section on Committer 
>>> Subversion
>>> -      Access on the <a 
>>> href="http://www.apache.org/dev/version-control.html">
>>> -      Apache Source Code Repositories</a> page.
>>> +     Committers should configure the <source>user.name</source>,
>>> +     <source>user.email</source> and 
>>> <source>core.autocrlf</source>
>>> +     git repository or global options with <source>git 
>>> config</source>.
>>> +     The first two options set the identity and mail of the 
>>> committer.
>>> +     The third option deals with line endings to achieve 
>>> consistency
>>> +     in line endings. Windows users should configure this option 
>>> to
>>> +     <source>true</source> while OS X and Linux users should 
>>> configure
>> Is the "user.name" the Apache id or just the real name? [I.e. what 
>> is this
>> setting used for?]
>
> It is the real name. It is used to populate the various fields in the 
> commit.
> If for example I run "git log -1 --format=full" in a command window 
> after
> the last commit I made a few minutes ago, I get:
>
> commit a67f0a33e68abf1c985db28b19ce70f427fd48bd
> Author: Luc Maisonobe <lu...@apache.org>
> Commit: Luc Maisonobe <lu...@apache.org>
>
>     Added all Java 8 StrictMath methods to FastMath.
>
>     This change allows FastMath to remain compatible with newer Java
>     versions, despite it stiil requires only Java 5 to compile and 
> run.
>
>     JIRA: MATH-1156
>
>
> So user.name was used to put Luc Maisonobe at the start of the Author
> and Commit fields,
> and user.email was used to append <lu...@apache.org> in the same fields 
> (note
> that the property value is luc@apache.org for me, the brackets have 
> been
> inserted automatically by Git when the commit was created.
>
>> Perhaps the documentation should show how one does actually set the
>> values. [The first few newbie documentation I came across did not
>> mention "git config".]
>
> I did not include it because it was already described in the Apache 
> page I
> linked to: <https://git-wip-us.apache.org/>, in the "Committers:
> Getting Started"
> section near the beginning of the page.
>
> I'll add a reference to the Git book too. Here it is:
> <http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration>.
>
>
>>
>>> +     it to <source>input</source>.
>> What is "input" and how does it differ from "true"?
>
> A ggod explanation is in the Git book page on configuration, here is
> a direct link:
> 
> <http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration#Formatting-and-Whitespace>.
>
> Basically, the core.autocrlf setting can take several different
> values: "true", "false", "input".
> True means that you always convert from the repository LF to
> workspace CRLF, which is useful for Windows.
> Input means that you convert only in one direction (from workspace to
> repository, stripping accidental
> CRLF so the repository is always clear with LF only), anf false means
> you don't convert anything, so
> it works only when everyone uses the same patform (i.e. all Windows
> or all Linux/OS-X). It is clearly
> irrelevant for us.
>
> best regards,
> Luc



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [Math] Apache/Git question (Was: [1/2] git commit: Updated developers documentation [...])

Posted by luc <lu...@spaceroots.org>.
Hi Gilles,

Le 2014-10-07 12:12, Gilles a écrit :
> Hello Luc.
> 
> On Mon, 06 Oct 2014 20:03:28 -0000, luc@apache.org wrote:
>> Repository: commons-math
>> Updated Branches:
>>   refs/heads/master 026af89ce -> e99b9ef25
>> 
>> 
>> Updated developers documentation after migration to Git.
>> 
>> Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
>> Commit: 
>> http://git-wip-us.apache.org/repos/asf/commons-math/commit/58ecf6b9
>> Tree: 
>> http://git-wip-us.apache.org/repos/asf/commons-math/tree/58ecf6b9
>> Diff: 
>> http://git-wip-us.apache.org/repos/asf/commons-math/diff/58ecf6b9
>> 
>> Branch: refs/heads/master
>> Commit: 58ecf6b9543e0b5edc2bef8c4f4b4965d0a70f24
>> Parents: 026af89
>> Author: Luc Maisonobe <lu...@apache.org>
>> Authored: Mon Oct 6 14:22:00 2014 +0200
>> Committer: Luc Maisonobe <lu...@apache.org>
>> Committed: Mon Oct 6 14:25:09 2014 +0200
>> 
>> 
>> ----------------------------------------------------------------------
>>  src/site/xdoc/developers.xml | 28 ++++++++++++++++------------
>>  1 file changed, 16 insertions(+), 12 deletions(-)
>> 
>> ----------------------------------------------------------------------
>> 
>> 
>> 
>> http://git-wip-us.apache.org/repos/asf/commons-math/blob/58ecf6b9/src/site/xdoc/developers.xml
>> 
>> ----------------------------------------------------------------------
>> diff --git a/src/site/xdoc/developers.xml 
>> b/src/site/xdoc/developers.xml
>> index 825fc22..d74595b 100644
>> --- a/src/site/xdoc/developers.xml
>> +++ b/src/site/xdoc/developers.xml
>> @@ -47,14 +47,14 @@
>>              founded.
>>          </li>
>>          <li>Download the Commons Math source code.  Follow the 
>> instructions
>> -        under the heading "Anonymous Subversion" on the
>> -        <a 
>> href="http://www.apache.org/dev/version-control.html">Apache version
>> -         control page</a>  (Also have a look at the
>> -        <a href="http://wiki.apache.org/commons/UsingSVN">Commons 
>> wiki
>> -        svn page </a>) to check out the Commons Math code base from 
>> Subversion.
>> -        The svn url for the current development sources of Commons 
>> Math
>> -        is
>> 
>> -<source>https://svn.apache.org/repos/asf/commons/proper/math/trunk</source>
>> +        under the heading "Repository Checkout" on the
>> +        <a href="https://git-wip-us.apache.org/">Git at the ASF 
>> page</a>.
>> +        The git url for the current development sources of Commons 
>> Math
>> +        is 
>> <source>http://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
>> +        for anonymous read-only access and
>> +        
>> <source>https://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
>> +        (where apacheid should be replaced by each committer Apache 
>> ID) for committers
>> +        read-write access.
>>          </li>
>>          <li>Like most commons components, Commons Math uses Apache
>> Maven as our
>>              build tool. The sources can also be built using Ant (a 
>> working
>> @@ -152,10 +152,14 @@
>>       Please make sure to set your IDE or editor to use spaces
>> instead of tabs.
>>      </p>
>>      <p>
>> -      Committers should make sure that svn properties are correctly 
>> set on
>> -      files added to the repository.  See the section on Committer 
>> Subversion
>> -      Access on the <a 
>> href="http://www.apache.org/dev/version-control.html">
>> -      Apache Source Code Repositories</a> page.
>> +     Committers should configure the <source>user.name</source>,
>> +     <source>user.email</source> and <source>core.autocrlf</source>
>> +     git repository or global options with <source>git 
>> config</source>.
>> +     The first two options set the identity and mail of the 
>> committer.
>> +     The third option deals with line endings to achieve consistency
>> +     in line endings. Windows users should configure this option to
>> +     <source>true</source> while OS X and Linux users should 
>> configure
> 
> Is the "user.name" the Apache id or just the real name? [I.e. what is 
> this
> setting used for?]

It is the real name. It is used to populate the various fields in the 
commit.
If for example I run "git log -1 --format=full" in a command window 
after
the last commit I made a few minutes ago, I get:

commit a67f0a33e68abf1c985db28b19ce70f427fd48bd
Author: Luc Maisonobe <lu...@apache.org>
Commit: Luc Maisonobe <lu...@apache.org>

     Added all Java 8 StrictMath methods to FastMath.

     This change allows FastMath to remain compatible with newer Java
     versions, despite it stiil requires only Java 5 to compile and run.

     JIRA: MATH-1156


So user.name was used to put Luc Maisonobe at the start of the Author 
and Commit fields,
and user.email was used to append <lu...@apache.org> in the same fields 
(note
that the property value is luc@apache.org for me, the brackets have been
inserted automatically by Git when the commit was created.

> 
> Perhaps the documentation should show how one does actually set the
> values. [The first few newbie documentation I came across did not
> mention "git config".]

I did not include it because it was already described in the Apache page 
I
linked to: <https://git-wip-us.apache.org/>, in the "Committers: Getting 
Started"
section near the beginning of the page.

I'll add a reference to the Git book too. Here it is: 
<http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration>.


> 
>> +     it to <source>input</source>.
> 
> What is "input" and how does it differ from "true"?

A ggod explanation is in the Git book page on configuration, here is a 
direct link:
<http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration#Formatting-and-Whitespace>.

Basically, the core.autocrlf setting can take several different values: 
"true", "false", "input".
True means that you always convert from the repository LF to workspace 
CRLF, which is useful for Windows.
Input means that you convert only in one direction (from workspace to 
repository, stripping accidental
CRLF so the repository is always clear with LF only), anf false means 
you don't convert anything, so
it works only when everyone uses the same patform (i.e. all Windows or 
all Linux/OS-X). It is clearly
irrelevant for us.

best regards,
Luc

> 
> 
> Thanks,
> Gilles
> 
>>      </p>
>>     </subsection>
>>     <subsection name='Documentation'>
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


[Math] Apache/Git question (Was: [1/2] git commit: Updated developers documentation [...])

Posted by Gilles <gi...@harfang.homelinux.org>.
Hello Luc.

On Mon, 06 Oct 2014 20:03:28 -0000, luc@apache.org wrote:
> Repository: commons-math
> Updated Branches:
>   refs/heads/master 026af89ce -> e99b9ef25
>
>
> Updated developers documentation after migration to Git.
>
> Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
> Commit: 
> http://git-wip-us.apache.org/repos/asf/commons-math/commit/58ecf6b9
> Tree: 
> http://git-wip-us.apache.org/repos/asf/commons-math/tree/58ecf6b9
> Diff: 
> http://git-wip-us.apache.org/repos/asf/commons-math/diff/58ecf6b9
>
> Branch: refs/heads/master
> Commit: 58ecf6b9543e0b5edc2bef8c4f4b4965d0a70f24
> Parents: 026af89
> Author: Luc Maisonobe <lu...@apache.org>
> Authored: Mon Oct 6 14:22:00 2014 +0200
> Committer: Luc Maisonobe <lu...@apache.org>
> Committed: Mon Oct 6 14:25:09 2014 +0200
>
> 
> ----------------------------------------------------------------------
>  src/site/xdoc/developers.xml | 28 ++++++++++++++++------------
>  1 file changed, 16 insertions(+), 12 deletions(-)
> 
> ----------------------------------------------------------------------
>
>
> 
> http://git-wip-us.apache.org/repos/asf/commons-math/blob/58ecf6b9/src/site/xdoc/developers.xml
> 
> ----------------------------------------------------------------------
> diff --git a/src/site/xdoc/developers.xml 
> b/src/site/xdoc/developers.xml
> index 825fc22..d74595b 100644
> --- a/src/site/xdoc/developers.xml
> +++ b/src/site/xdoc/developers.xml
> @@ -47,14 +47,14 @@
>              founded.
>          </li>
>          <li>Download the Commons Math source code.  Follow the 
> instructions
> -        under the heading "Anonymous Subversion" on the
> -        <a 
> href="http://www.apache.org/dev/version-control.html">Apache version
> -         control page</a>  (Also have a look at the
> -        <a href="http://wiki.apache.org/commons/UsingSVN">Commons 
> wiki
> -        svn page </a>) to check out the Commons Math code base from 
> Subversion.
> -        The svn url for the current development sources of Commons 
> Math
> -        is
> 
> -<source>https://svn.apache.org/repos/asf/commons/proper/math/trunk</source>
> +        under the heading "Repository Checkout" on the
> +        <a href="https://git-wip-us.apache.org/">Git at the ASF 
> page</a>.
> +        The git url for the current development sources of Commons 
> Math
> +        is 
> <source>http://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
> +        for anonymous read-only access and
> +        
> <source>https://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
> +        (where apacheid should be replaced by each committer Apache 
> ID) for committers
> +        read-write access.
>          </li>
>          <li>Like most commons components, Commons Math uses Apache
> Maven as our
>              build tool. The sources can also be built using Ant (a 
> working
> @@ -152,10 +152,14 @@
>       Please make sure to set your IDE or editor to use spaces
> instead of tabs.
>      </p>
>      <p>
> -      Committers should make sure that svn properties are correctly 
> set on
> -      files added to the repository.  See the section on Committer 
> Subversion
> -      Access on the <a 
> href="http://www.apache.org/dev/version-control.html">
> -      Apache Source Code Repositories</a> page.
> +     Committers should configure the <source>user.name</source>,
> +     <source>user.email</source> and <source>core.autocrlf</source>
> +     git repository or global options with <source>git 
> config</source>.
> +     The first two options set the identity and mail of the 
> committer.
> +     The third option deals with line endings to achieve consistency
> +     in line endings. Windows users should configure this option to
> +     <source>true</source> while OS X and Linux users should 
> configure

Is the "user.name" the Apache id or just the real name? [I.e. what is 
this
setting used for?]

Perhaps the documentation should show how one does actually set the
values. [The first few newbie documentation I came across did not
mention "git config".]

> +     it to <source>input</source>.

What is "input" and how does it differ from "true"?


Thanks,
Gilles

>      </p>
>     </subsection>
>     <subsection name='Documentation'>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org