You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by mt...@apache.org on 2019/10/27 15:29:11 UTC
svn commit: r1869039 -
/ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
Author: mthl
Date: Sun Oct 27 15:29:10 2019
New Revision: 1869039
URL: http://svn.apache.org/viewvc?rev=1869039&view=rev
Log:
Fixed: Fix javadoc build
(OFBIZ-11007)
This fixes the javadoc errors introduced in revision 1868963.
Modified:
ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
Modified: ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java?rev=1869039&r1=1869038&r2=1869039&view=diff
==============================================================================
--- ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java (original)
+++ ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java Sun Oct 27 15:29:10 2019
@@ -99,10 +99,10 @@ public class ControlServlet extends Http
/**
* Invokes {@link RequestHandler#doRequest} with error handling.
*
- * @param req an {@link HttpServletRequest} object that contains the request
- * the client has made of the servlet
- * @param resp an {@link HttpServletResponse} object that contains the response
- * the servlet sends to the client
+ * @param request an {@link HttpServletRequest} object that contains the request
+ * the client has made of the servlet
+ * @param response an {@link HttpServletResponse} object that contains the response
+ * the servlet sends to the client
* @throws IOException if an output error is detected when trying to write on the response.
*/
public void handle(HttpServletRequest request, HttpServletResponse response) throws IOException {
Re: svn commit: r1869039 - /ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
Posted by Mathieu Lirzin <ma...@nereide.fr>.
Hello Aditya,
Aditya Sharma <ad...@apache.org> writes:
> Just to clarify, as per commit message template document[1] the template is
>
> [Implemented|Improved|Fixed|Completed|Documented|Reverted]: [Jira
> title|Free text]
>
> Can we use "Free text" instead of "Jira title" when committing specifically
> for any Jira?
Indeed there is a grammar ambiguity in the commit template. My personal
interpretation was that using the “Jira title” was only for trivial
stuff or when being uninspired. :-)
In practice I always use "free text" to avoid having multiple commits
with the same commit summary (e.g. first line) which IMO helps
identifying commits when displaying a short version of the log history
with:
git log --oneline
When using “Jira title” form we end up with something like
Improved: OFBIz does not have *magic feature* (OFBIZ-XXXXX)
Improved: OFBIz does not have *magic feature* (OFBIZ-XXXXX)
Fixed: OFBIz does not have *magic feature* (OFBIZ-XXXXX)
Improved: OFBIz does not have *magic feature* (OFBIZ-XXXXX)
Implemented: OFBIz does not have *magic feature* (OFBIZ-XXXXX)
Implemented: OFBIz does not have *magic feature* (OFBIZ-XXXXX)
Where as when using the “free text” form we can get something more
informative like
Improved: Remove uneeded code in bar (OFBIZ-XXXXX)
Improved: Refactor magic feature to avoid foo (OFBIZ-XXXXX)
Fixed: Fix regression from magic feature (OFBIZ-XXXXX)
Improved: Avoid unecessary null checks (OFBIZ-XXXXX)
Implemented: Add new magic feature (OFBIZ-XXXXX)
Implemented: Add new tests for module foo (OFBIZ-XXXXX)
In any case if we collectively decide that the first form is preferable,
I will conform to that guideline.
Thanks.
--
Mathieu Lirzin
GPG: F2A3 8D7E EB2B 6640 5761 070D 0ADE E100 9460 4D37
Re: svn commit: r1869039 - /ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
Posted by Aditya Sharma <ad...@apache.org>.
Makes sense to me. Thanks Jacques, Mathieu, and Jacopo for the
clarification :)
Thanks and regards,
Aditya Sharma
On Tue, Oct 29, 2019 at 10:15 PM Jacopo Cappellato <
jacopo.cappellato@gmail.com> wrote:
> On Tue, Oct 29, 2019 at 2:18 PM Aditya Sharma <ad...@apache.org>
> wrote:
>
> > Hi team,
> >
> > Just to clarify, as per commit message template document[1] the template
> is
> >
> > [Implemented|Improved|Fixed|Completed|Documented|Reverted]: [Jira
> > title|Free text]
> >
> > Can we use "Free text" instead of "Jira title" when committing
> specifically
> > for any Jira?
> >
> >
> My interpretation is that the | symbol means OR: "Jira title" OR "Free
> text".
> I think it is completely fine (or even preferable) to provide a free text
> to describe a commit done for a Jira ticket (according to the template, the
> ticket id can be provided in the parenthesis).
>
> Jacopo
>
Re: svn commit: r1869039 - /ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
Posted by Jacopo Cappellato <ja...@gmail.com>.
On Tue, Oct 29, 2019 at 2:18 PM Aditya Sharma <ad...@apache.org>
wrote:
> Hi team,
>
> Just to clarify, as per commit message template document[1] the template is
>
> [Implemented|Improved|Fixed|Completed|Documented|Reverted]: [Jira
> title|Free text]
>
> Can we use "Free text" instead of "Jira title" when committing specifically
> for any Jira?
>
>
My interpretation is that the | symbol means OR: "Jira title" OR "Free
text".
I think it is completely fine (or even preferable) to provide a free text
to describe a commit done for a Jira ticket (according to the template, the
ticket id can be provided in the parenthesis).
Jacopo
Re: svn commit: r1869039 -
/ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
Posted by Jacques Le Roux <ja...@les7arts.com>.
Hi Aditya,
I see no problems with that since sometimes the Jira title is not right (though we can then fix it before copying it), convenient, not long enough, or ...
Jacques
Le 29/10/2019 à 14:17, Aditya Sharma a écrit :
> Hi team,
>
> Just to clarify, as per commit message template document[1] the template is
>
> [Implemented|Improved|Fixed|Completed|Documented|Reverted]: [Jira
> title|Free text]
>
> Can we use "Free text" instead of "Jira title" when committing specifically
> for any Jira?
>
> 1.
> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>
>
> Thanks and Regards,
> Aditya Sharma
>
>
> On Sun, Oct 27, 2019 at 8:59 PM <mt...@apache.org> wrote:
>
>> Author: mthl
>> Date: Sun Oct 27 15:29:10 2019
>> New Revision: 1869039
>>
>> URL: http://svn.apache.org/viewvc?rev=1869039&view=rev
>> Log:
>> Fixed: Fix javadoc build
>> (OFBIZ-11007)
>>
>> This fixes the javadoc errors introduced in revision 1868963.
>>
>> Modified:
>>
>> ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
>>
>> Modified:
>> ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
>> URL:
>> http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java?rev=1869039&r1=1869038&r2=1869039&view=diff
>>
>> ==============================================================================
>> ---
>> ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
>> (original)
>> +++
>> ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
>> Sun Oct 27 15:29:10 2019
>> @@ -99,10 +99,10 @@ public class ControlServlet extends Http
>> /**
>> * Invokes {@link RequestHandler#doRequest} with error handling.
>> *
>> - * @param req an {@link HttpServletRequest} object that contains the
>> request
>> - * the client has made of the servlet
>> - * @param resp an {@link HttpServletResponse} object that contains
>> the response
>> - * the servlet sends to the client
>> + * @param request an {@link HttpServletRequest} object that contains
>> the request
>> + * the client has made of the servlet
>> + * @param response an {@link HttpServletResponse} object that
>> contains the response
>> + * the servlet sends to the client
>> * @throws IOException if an output error is detected when trying to
>> write on the response.
>> */
>> public void handle(HttpServletRequest request, HttpServletResponse
>> response) throws IOException {
>>
>>
>>
Re: svn commit: r1869039 - /ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
Posted by Aditya Sharma <ad...@apache.org>.
Hi team,
Just to clarify, as per commit message template document[1] the template is
[Implemented|Improved|Fixed|Completed|Documented|Reverted]: [Jira
title|Free text]
Can we use "Free text" instead of "Jira title" when committing specifically
for any Jira?
1.
https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
Thanks and Regards,
Aditya Sharma
On Sun, Oct 27, 2019 at 8:59 PM <mt...@apache.org> wrote:
> Author: mthl
> Date: Sun Oct 27 15:29:10 2019
> New Revision: 1869039
>
> URL: http://svn.apache.org/viewvc?rev=1869039&view=rev
> Log:
> Fixed: Fix javadoc build
> (OFBIZ-11007)
>
> This fixes the javadoc errors introduced in revision 1868963.
>
> Modified:
>
> ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
>
> Modified:
> ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
> URL:
> http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java?rev=1869039&r1=1869038&r2=1869039&view=diff
>
> ==============================================================================
> ---
> ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
> (original)
> +++
> ofbiz/ofbiz-framework/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/control/ControlServlet.java
> Sun Oct 27 15:29:10 2019
> @@ -99,10 +99,10 @@ public class ControlServlet extends Http
> /**
> * Invokes {@link RequestHandler#doRequest} with error handling.
> *
> - * @param req an {@link HttpServletRequest} object that contains the
> request
> - * the client has made of the servlet
> - * @param resp an {@link HttpServletResponse} object that contains
> the response
> - * the servlet sends to the client
> + * @param request an {@link HttpServletRequest} object that contains
> the request
> + * the client has made of the servlet
> + * @param response an {@link HttpServletResponse} object that
> contains the response
> + * the servlet sends to the client
> * @throws IOException if an output error is detected when trying to
> write on the response.
> */
> public void handle(HttpServletRequest request, HttpServletResponse
> response) throws IOException {
>
>
>