OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

opencsa-liaison message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: RE: [opencsa-liaison] Use of "may", "must", etc.


Sanjay, Check the minutes of the Policy TC from Oct 1,  I'll paste it here:

                                                                            
   Sanjay: Open CSA Steering Committee's recommendation regarding use of    
   RFC 2119                                                                 
                                                                            
   keywords (and versioning):                                               
                                                                            
   http://lists.oasis-open.org/archives/sca-                                
                                                                            
   policy/200710/msg00000.html                                              
                                                                            
   Sanjay: The Steering Committee (SC) recommends to each SCA Technical     
   Committee                                                                
                                                                            
   to use the RFC 2119 keywords along with the following restrictions in    
   their                                                                    
                                                                            
   specifications:                                                          
                                                                            
   a) All RFC 2119 keywords will be of the uppercase form (for example,     
   RFC 2119                                                                 
                                                                            
   keywords MUST be capitalized)                                            
                                                                            
   b) Use of lower-case 2119 keywords will not be used in the spec. When    
   the use of 2119                                                          
                                                                            
   keyword is needed, without having the implications wrt conformance, a    
   suitable synonym                                                         
                                                                            
   will be found.                                                           
                                                                            
   c) RFC 2119 defines keywords that are synonyms of each other. For        
   example 'SHALL'                                                          
                                                                            
   and 'MUST' mean the same thing. The TC should not use multiple forms to  
   mean the                                                                 
                                                                            
   same. Therefore the TC should use 'MUST' instead of 'SHALL' and 'MUST    
   NOT' instead                                                             
                                                                            
   of 'SHALL NOT' through out the spec.                                     
                                                                            
   Sanjay: Moves to accept the resolution as proposed by the SC             
                                                                            
   Martin Chapman: seconds                                                  
                                                                            
   Resolution 3: Use RFC 2119 keywords as recommended by the Open CSA SC,   
                                                                            
   accepted unanimously                                                     
                                                                            




So yes, we accepted RFC2119 + some stuff.  I think the other TCs did
someting similar.


Dave Booz
STSM, SCA and WebSphere Architecture
Co-Chair OASIS SCA-Policy TC
"Distributed objects first, then world hunger"
Poughkeepsie, NY (845)-435-6093  or  8-295-6093
e-mail:booz@us.ibm.com
http://washome.austin.ibm.com/xwiki/bin/view/SCA2Team/WebHome


                                                                           
             "Patil, Sanjay"                                               
             <sanjay.patil@sap                                             
             .com>                                                      To 
                                       <ashok.malhotra@oracle.com>, Bryan  
             12/04/2007 10:34          Aupperle/Raleigh/IBM@IBMUS          
             AM                                                         cc 
                                       <opencsa-liaison@lists.oasis-open.o 
                                       rg>                                 
                                                                   Subject 
                                       RE: [opencsa-liaison] Use of "may", 
                                       "must", etc.                        
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           





If we did that (that is treat the terms in lower-case differently from
their upper-case version), then our specs can not claim full compliance
with RFC 2119, since RFC 2119 does not differentiate the key words based
on their case. The problem with invoking RFC 2119 only for upper-case
keywords would be that - we might be upsetting a lot of readers out
there who have by now started expecting a full compliance with RFC 2119.

Bryan, could you give us one or two examples of the awkwardness you
faced while substituting the RFC terms? Perhaps we can just identify the
common situations of such awkwardness and try to come up with some
alternative terms that can be uniformly used by all the SCA specs.

-- Sanjay

> -----Original Message-----
> From: ashok malhotra [mailto:ashok.malhotra@oracle.com]
> Sent: Tuesday, Dec 04, 2007 6:32 AM
> To: Bryan Aupperle
> Cc: opencsa-liaison@lists.oasis-open.org
> Subject: Re: [opencsa-liaison] Use of "may", "must", etc.
>
> Hi Bryan:
> I agree that this is a problem.  My alternate proposal is that the
> upper-case words indicate the RFC 2119 keywords and the
> lower-case words
> indicate normal English usage.  But not everyone likes this solution.
>
> Bryan Aupperle wrote:
>
> >
> > I believe all of the TCs have adopted use of RFC 2119 keywords in
> > uppercase only and to not use the keywords in lower-case
> form at all,
> > using synonyms when necessary.  We have started scrubbing
> the C++ spec
> > to eliminate use of "may", "must", etc. and found that some rather
> > awkward language can result   Has anyone else started this exercise
> > and how are your results?
> >
> > Bryan Aupperle, Ph.D.
> > STSM, WebSphere Enterprise Platform Software Solution Architect
> > Master Inventor
> >
> > Research Triangle Park,  NC
> > +1 919-254-7508 (T/L 444-7508)
> > Internet Address: aupperle@us.ibm.com
>
>
>
> --
> All the best, Ashok
>
> ---------------------------------------------------------------------
> To unsubscribe from this mail list, you must leave the OASIS TC that
> generates this mail.  You may a link to this group and all
> your TCs in OASIS
> at:
> https://www.oasis-open.org/apps/org/workgroup/portal/my_workgr
> oups.php
>
>

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that
generates this mail.  You may a link to this group and all your TCs in
OASIS
at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php





[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]