You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ri...@apache.org on 2007/08/31 06:42:23 UTC
svn commit: r571371 -
/maven/site/trunk/src/site/apt/developers/committer-environment.apt
Author: rinku
Date: Thu Aug 30 21:42:23 2007
New Revision: 571371
URL: http://svn.apache.org/viewvc?rev=571371&view=rev
Log:
o fixed references to Eclipse and IDEA code formatter preferences.
Modified:
maven/site/trunk/src/site/apt/developers/committer-environment.apt
Modified: maven/site/trunk/src/site/apt/developers/committer-environment.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/committer-environment.apt?rev=571371&r1=571370&r2=571371&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/developers/committer-environment.apt (original)
+++ maven/site/trunk/src/site/apt/developers/committer-environment.apt Thu Aug 30 21:42:23 2007
@@ -43,7 +43,7 @@
* IntelliJ IDEA 4.5+
- Download <<<{{{maven-idea-codestyle.xml}maven-idea-codestyle.xml}}>>> and copy it to
+ Download <<<{{{./maven-idea-codestyle.xml}maven-idea-codestyle.xml}}>>> and copy it to
<<<~/.IntelliJIDEA/config/codestyles>>> then restart IDEA. On Windows, try
<<<C:\Documents and Settings\<username>\.IntelliJIDEA\config\codestyles>>>
@@ -51,7 +51,7 @@
* Eclipse 3.2+
- Download <<<{{{maven-eclipse-codestyle.xml}maven-eclipse-codestyle.xml}}>>>.
+ Download <<<{{{./maven-eclipse-codestyle.xml}maven-eclipse-codestyle.xml}}>>>.
After this, select Window \> Preferences, and open up the configuration for Java \> Code
Style \> Code Formatter. Click on the button labeled Import... and select the file you
Re: svn commit: r571371 - /maven/site/trunk/src/site/apt/developers/committer-environment.apt
Posted by Rahul Thakur <ra...@gmail.com>.
On 8/31/07, Lukas Theussl <lt...@apache.org> wrote:
>
>
> Brett Porter wrote:
> > Sorry, I missed that. Your solution is definitely compliant with what
> > the APT "spec" says, so that's good.
> >
> > What might be nice is that doxia keeps track of all the anchor
> > references and throws an exception if the anchor is never found in the
> > document - that'll catch these much more easily than a link check.
>
> I'm not sure about that. First, it would only be a partial solution, as
> it would only work for internal links, for which an anchor has to exist
> within the same source document. For links to other files you always
> have to check whether the referenced file actually exists. Then, in a
> multi-module build, some links might only be valid after a site deploy,
> but never locally.
>
> But for local links we could issue a warning if the corresponding anchor
> is not found. Note however that it would have to be done by each parser
> separately (apt, xdoc), so it's likely not to be consistent for
> different input formats, and I don't think it will be that straight
> forward. A linkchecker would only operate on the final output files,
> independently of where they came from, so it's a more universal tool.
>
> Finally, IMO it's not doxia's job to check for valid user input at all
> (apart from parse exceptions if the source can't be parsed in the first
> place), that should really be done by an independent tool.
I agree here. I think it would be the responsibility of the Entity
that invokes the parser to take care of. It can delegate the link
validation to a linkchecker.
Can additional info (track of invalid anchors, links) be wrapped up in
the exceptions thrown and be bubbled up to Entity to make it easier to
run a linkcheck after the parser has finished execution. I am not
versed with Doxia internals but I am guessing it might work in case of
multi-module builds where the results are aggregated.
Cheers,
Rahul
>
> -Lukas
>
> >
> > Cheers,
> > Brett
> >
> > On 31/08/2007, at 5:10 PM, Lukas Theussl wrote:
> >
> >> It's part of a bug-fix: external links in apt files (ie links outside
> >> the current source document) have to start with './' or '../',
> >> otherwise I don't see how we could fix http://
> >> jira.codehaus.org/browse/DOXIA-47. We have implemented a hacky
> >> workaround for html files to preserve backward compat, but not for
> >> other file formats, like .txt, .pdf etc.
> >>
> >> I guess we should have pushed that for the beta-1 release of doxia
> >> because the behavior is not consistent now within alpha-9. But then,
> >> it's alpha...
> >>
> >> Btw, thanks rinku for fixing those links, I am currently working on
> >> the linkcheck port to m2 which will allow us to find these broken
> >> links more systematically (I'm sure there are more...)
> >>
> >> -Lukas
> >>
> >> Brett Porter wrote:
> >>
> >>> This is also a regression in doxia, then?
> >>> - Brett
> >>> On 31/08/2007, at 2:42 PM, rinku@apache.org wrote:
> >>>
> >>>> Author: rinku
> >>>> Date: Thu Aug 30 21:42:23 2007
> >>>> New Revision: 571371
> >>>>
> >>>> URL: http://svn.apache.org/viewvc?rev=571371&view=rev
> >>>> Log:
> >>>> o fixed references to Eclipse and IDEA code formatter preferences.
> >>>>
> >>>> Modified:
> >>>> maven/site/trunk/src/site/apt/developers/committer- environment.apt
> >>>>
> >>>> Modified: maven/site/trunk/src/site/apt/developers/committer-
> >>>> environment.apt
> >>>> URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/
> >>>> developers/committer-environment.apt?
> >>>> rev=571371&r1=571370&r2=571371&view=diff
> >>>> ====================================================================
> >>>> == ========
> >>>> --- maven/site/trunk/src/site/apt/developers/committer-
> >>>> environment.apt (original)
> >>>> +++ maven/site/trunk/src/site/apt/developers/committer-
> >>>> environment.apt Thu Aug 30 21:42:23 2007
> >>>> @@ -43,7 +43,7 @@
> >>>>
> >>>> * IntelliJ IDEA 4.5+
> >>>>
> >>>> - Download <<<{{{maven-idea-codestyle.xml}maven-idea-
> >>>> codestyle.xml}} >>> and copy it to
> >>>> + Download <<<{{{./maven-idea-codestyle.xml}maven-idea-
> >>>> codestyle.xml}}>>> and copy it to
> >>>> <<<~/.IntelliJIDEA/config/codestyles>>> then restart IDEA. On
> >>>> Windows, try
> >>>> <<<C:\Documents and Settings\<username>\.IntelliJIDEA\config
> >>>> \codestyles>>>
> >>>>
> >>>> @@ -51,7 +51,7 @@
> >>>>
> >>>> * Eclipse 3.2+
> >>>>
> >>>> - Download <<<{{{maven-eclipse-codestyle.xml}maven-eclipse-
> >>>> codestyle.xml}}>>>.
> >>>> + Download <<<{{{./maven-eclipse-codestyle.xml}maven-eclipse-
> >>>> codestyle.xml}}>>>.
> >>>>
> >>>> After this, select Window \> Preferences, and open up the
> >>>> configuration for Java \> Code
> >>>> Style \> Code Formatter. Click on the button labeled Import...
> >>>> and select the file you
> >>>>
> >>> --
> >>> Brett Porter - brett@apache.org
> >>> Blog: http://www.devzuz.org/blogs/bporter/
> >>> ---------------------------------------------------------------------
> >>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>> For additional commands, e-mail: dev-help@maven.apache.org
> >>
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >> For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
> > --
> > Brett Porter - brett@apache.org
> > Blog: http://www.devzuz.org/blogs/bporter/
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r571371 - /maven/site/trunk/src/site/apt/developers/committer-environment.apt
Posted by Lukas Theussl <lt...@apache.org>.
Brett Porter wrote:
> Sorry, I missed that. Your solution is definitely compliant with what
> the APT "spec" says, so that's good.
>
> What might be nice is that doxia keeps track of all the anchor
> references and throws an exception if the anchor is never found in the
> document - that'll catch these much more easily than a link check.
I'm not sure about that. First, it would only be a partial solution, as
it would only work for internal links, for which an anchor has to exist
within the same source document. For links to other files you always
have to check whether the referenced file actually exists. Then, in a
multi-module build, some links might only be valid after a site deploy,
but never locally.
But for local links we could issue a warning if the corresponding anchor
is not found. Note however that it would have to be done by each parser
separately (apt, xdoc), so it's likely not to be consistent for
different input formats, and I don't think it will be that straight
forward. A linkchecker would only operate on the final output files,
independently of where they came from, so it's a more universal tool.
Finally, IMO it's not doxia's job to check for valid user input at all
(apart from parse exceptions if the source can't be parsed in the first
place), that should really be done by an independent tool.
-Lukas
>
> Cheers,
> Brett
>
> On 31/08/2007, at 5:10 PM, Lukas Theussl wrote:
>
>> It's part of a bug-fix: external links in apt files (ie links outside
>> the current source document) have to start with './' or '../',
>> otherwise I don't see how we could fix http://
>> jira.codehaus.org/browse/DOXIA-47. We have implemented a hacky
>> workaround for html files to preserve backward compat, but not for
>> other file formats, like .txt, .pdf etc.
>>
>> I guess we should have pushed that for the beta-1 release of doxia
>> because the behavior is not consistent now within alpha-9. But then,
>> it's alpha...
>>
>> Btw, thanks rinku for fixing those links, I am currently working on
>> the linkcheck port to m2 which will allow us to find these broken
>> links more systematically (I'm sure there are more...)
>>
>> -Lukas
>>
>> Brett Porter wrote:
>>
>>> This is also a regression in doxia, then?
>>> - Brett
>>> On 31/08/2007, at 2:42 PM, rinku@apache.org wrote:
>>>
>>>> Author: rinku
>>>> Date: Thu Aug 30 21:42:23 2007
>>>> New Revision: 571371
>>>>
>>>> URL: http://svn.apache.org/viewvc?rev=571371&view=rev
>>>> Log:
>>>> o fixed references to Eclipse and IDEA code formatter preferences.
>>>>
>>>> Modified:
>>>> maven/site/trunk/src/site/apt/developers/committer- environment.apt
>>>>
>>>> Modified: maven/site/trunk/src/site/apt/developers/committer-
>>>> environment.apt
>>>> URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/
>>>> developers/committer-environment.apt?
>>>> rev=571371&r1=571370&r2=571371&view=diff
>>>> ====================================================================
>>>> == ========
>>>> --- maven/site/trunk/src/site/apt/developers/committer-
>>>> environment.apt (original)
>>>> +++ maven/site/trunk/src/site/apt/developers/committer-
>>>> environment.apt Thu Aug 30 21:42:23 2007
>>>> @@ -43,7 +43,7 @@
>>>>
>>>> * IntelliJ IDEA 4.5+
>>>>
>>>> - Download <<<{{{maven-idea-codestyle.xml}maven-idea-
>>>> codestyle.xml}} >>> and copy it to
>>>> + Download <<<{{{./maven-idea-codestyle.xml}maven-idea-
>>>> codestyle.xml}}>>> and copy it to
>>>> <<<~/.IntelliJIDEA/config/codestyles>>> then restart IDEA. On
>>>> Windows, try
>>>> <<<C:\Documents and Settings\<username>\.IntelliJIDEA\config
>>>> \codestyles>>>
>>>>
>>>> @@ -51,7 +51,7 @@
>>>>
>>>> * Eclipse 3.2+
>>>>
>>>> - Download <<<{{{maven-eclipse-codestyle.xml}maven-eclipse-
>>>> codestyle.xml}}>>>.
>>>> + Download <<<{{{./maven-eclipse-codestyle.xml}maven-eclipse-
>>>> codestyle.xml}}>>>.
>>>>
>>>> After this, select Window \> Preferences, and open up the
>>>> configuration for Java \> Code
>>>> Style \> Code Formatter. Click on the button labeled Import...
>>>> and select the file you
>>>>
>>> --
>>> Brett Porter - brett@apache.org
>>> Blog: http://www.devzuz.org/blogs/bporter/
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>> For additional commands, e-mail: dev-help@maven.apache.org
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>
>
> --
> Brett Porter - brett@apache.org
> Blog: http://www.devzuz.org/blogs/bporter/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r571371 - /maven/site/trunk/src/site/apt/developers/committer-environment.apt
Posted by Brett Porter <br...@apache.org>.
Sorry, I missed that. Your solution is definitely compliant with what
the APT "spec" says, so that's good.
What might be nice is that doxia keeps track of all the anchor
references and throws an exception if the anchor is never found in
the document - that'll catch these much more easily than a link check.
Cheers,
Brett
On 31/08/2007, at 5:10 PM, Lukas Theussl wrote:
> It's part of a bug-fix: external links in apt files (ie links
> outside the current source document) have to start with './' or
> '../', otherwise I don't see how we could fix http://
> jira.codehaus.org/browse/DOXIA-47. We have implemented a hacky
> workaround for html files to preserve backward compat, but not for
> other file formats, like .txt, .pdf etc.
>
> I guess we should have pushed that for the beta-1 release of doxia
> because the behavior is not consistent now within alpha-9. But
> then, it's alpha...
>
> Btw, thanks rinku for fixing those links, I am currently working on
> the linkcheck port to m2 which will allow us to find these broken
> links more systematically (I'm sure there are more...)
>
> -Lukas
>
> Brett Porter wrote:
>> This is also a regression in doxia, then?
>> - Brett
>> On 31/08/2007, at 2:42 PM, rinku@apache.org wrote:
>>> Author: rinku
>>> Date: Thu Aug 30 21:42:23 2007
>>> New Revision: 571371
>>>
>>> URL: http://svn.apache.org/viewvc?rev=571371&view=rev
>>> Log:
>>> o fixed references to Eclipse and IDEA code formatter preferences.
>>>
>>> Modified:
>>> maven/site/trunk/src/site/apt/developers/committer-
>>> environment.apt
>>>
>>> Modified: maven/site/trunk/src/site/apt/developers/committer-
>>> environment.apt
>>> URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/
>>> developers/committer-environment.apt?
>>> rev=571371&r1=571370&r2=571371&view=diff
>>> ====================================================================
>>> == ========
>>> --- maven/site/trunk/src/site/apt/developers/committer-
>>> environment.apt (original)
>>> +++ maven/site/trunk/src/site/apt/developers/committer-
>>> environment.apt Thu Aug 30 21:42:23 2007
>>> @@ -43,7 +43,7 @@
>>>
>>> * IntelliJ IDEA 4.5+
>>>
>>> - Download <<<{{{maven-idea-codestyle.xml}maven-idea-
>>> codestyle.xml}} >>> and copy it to
>>> + Download <<<{{{./maven-idea-codestyle.xml}maven-idea-
>>> codestyle.xml}}>>> and copy it to
>>> <<<~/.IntelliJIDEA/config/codestyles>>> then restart IDEA. On
>>> Windows, try
>>> <<<C:\Documents and Settings\<username>\.IntelliJIDEA\config
>>> \codestyles>>>
>>>
>>> @@ -51,7 +51,7 @@
>>>
>>> * Eclipse 3.2+
>>>
>>> - Download <<<{{{maven-eclipse-codestyle.xml}maven-eclipse-
>>> codestyle.xml}}>>>.
>>> + Download <<<{{{./maven-eclipse-codestyle.xml}maven-eclipse-
>>> codestyle.xml}}>>>.
>>>
>>> After this, select Window \> Preferences, and open up the
>>> configuration for Java \> Code
>>> Style \> Code Formatter. Click on the button labeled Import...
>>> and select the file you
>>>
>> --
>> Brett Porter - brett@apache.org
>> Blog: http://www.devzuz.org/blogs/bporter/
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
--
Brett Porter - brett@apache.org
Blog: http://www.devzuz.org/blogs/bporter/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r571371 - /maven/site/trunk/src/site/apt/developers/committer-environment.apt
Posted by Lukas Theussl <lt...@apache.org>.
It's part of a bug-fix: external links in apt files (ie links outside
the current source document) have to start with './' or '../', otherwise
I don't see how we could fix http://jira.codehaus.org/browse/DOXIA-47.
We have implemented a hacky workaround for html files to preserve
backward compat, but not for other file formats, like .txt, .pdf etc.
I guess we should have pushed that for the beta-1 release of doxia
because the behavior is not consistent now within alpha-9. But then,
it's alpha...
Btw, thanks rinku for fixing those links, I am currently working on the
linkcheck port to m2 which will allow us to find these broken links more
systematically (I'm sure there are more...)
-Lukas
Brett Porter wrote:
> This is also a regression in doxia, then?
>
> - Brett
>
> On 31/08/2007, at 2:42 PM, rinku@apache.org wrote:
>
>> Author: rinku
>> Date: Thu Aug 30 21:42:23 2007
>> New Revision: 571371
>>
>> URL: http://svn.apache.org/viewvc?rev=571371&view=rev
>> Log:
>> o fixed references to Eclipse and IDEA code formatter preferences.
>>
>> Modified:
>> maven/site/trunk/src/site/apt/developers/committer-environment.apt
>>
>> Modified: maven/site/trunk/src/site/apt/developers/committer-
>> environment.apt
>> URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/
>> developers/committer-environment.apt?
>> rev=571371&r1=571370&r2=571371&view=diff
>> ======================================================================
>> ========
>> --- maven/site/trunk/src/site/apt/developers/committer-
>> environment.apt (original)
>> +++ maven/site/trunk/src/site/apt/developers/committer-
>> environment.apt Thu Aug 30 21:42:23 2007
>> @@ -43,7 +43,7 @@
>>
>> * IntelliJ IDEA 4.5+
>>
>> - Download <<<{{{maven-idea-codestyle.xml}maven-idea-codestyle.xml}}
>> >>> and copy it to
>> + Download <<<{{{./maven-idea-codestyle.xml}maven-idea-
>> codestyle.xml}}>>> and copy it to
>> <<<~/.IntelliJIDEA/config/codestyles>>> then restart IDEA. On
>> Windows, try
>> <<<C:\Documents and Settings\<username>\.IntelliJIDEA\config
>> \codestyles>>>
>>
>> @@ -51,7 +51,7 @@
>>
>> * Eclipse 3.2+
>>
>> - Download <<<{{{maven-eclipse-codestyle.xml}maven-eclipse-
>> codestyle.xml}}>>>.
>> + Download <<<{{{./maven-eclipse-codestyle.xml}maven-eclipse-
>> codestyle.xml}}>>>.
>>
>> After this, select Window \> Preferences, and open up the
>> configuration for Java \> Code
>> Style \> Code Formatter. Click on the button labeled Import... and
>> select the file you
>>
>
> --
> Brett Porter - brett@apache.org
> Blog: http://www.devzuz.org/blogs/bporter/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r571371 - /maven/site/trunk/src/site/apt/developers/committer-environment.apt
Posted by Brett Porter <br...@apache.org>.
This is also a regression in doxia, then?
- Brett
On 31/08/2007, at 2:42 PM, rinku@apache.org wrote:
> Author: rinku
> Date: Thu Aug 30 21:42:23 2007
> New Revision: 571371
>
> URL: http://svn.apache.org/viewvc?rev=571371&view=rev
> Log:
> o fixed references to Eclipse and IDEA code formatter preferences.
>
> Modified:
> maven/site/trunk/src/site/apt/developers/committer-environment.apt
>
> Modified: maven/site/trunk/src/site/apt/developers/committer-
> environment.apt
> URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/
> developers/committer-environment.apt?
> rev=571371&r1=571370&r2=571371&view=diff
> ======================================================================
> ========
> --- maven/site/trunk/src/site/apt/developers/committer-
> environment.apt (original)
> +++ maven/site/trunk/src/site/apt/developers/committer-
> environment.apt Thu Aug 30 21:42:23 2007
> @@ -43,7 +43,7 @@
>
> * IntelliJ IDEA 4.5+
>
> - Download <<<{{{maven-idea-codestyle.xml}maven-idea-codestyle.xml}}
> >>> and copy it to
> + Download <<<{{{./maven-idea-codestyle.xml}maven-idea-
> codestyle.xml}}>>> and copy it to
> <<<~/.IntelliJIDEA/config/codestyles>>> then restart IDEA. On
> Windows, try
> <<<C:\Documents and Settings\<username>\.IntelliJIDEA\config
> \codestyles>>>
>
> @@ -51,7 +51,7 @@
>
> * Eclipse 3.2+
>
> - Download <<<{{{maven-eclipse-codestyle.xml}maven-eclipse-
> codestyle.xml}}>>>.
> + Download <<<{{{./maven-eclipse-codestyle.xml}maven-eclipse-
> codestyle.xml}}>>>.
>
> After this, select Window \> Preferences, and open up the
> configuration for Java \> Code
> Style \> Code Formatter. Click on the button labeled Import...
> and select the file you
>
--
Brett Porter - brett@apache.org
Blog: http://www.devzuz.org/blogs/bporter/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org