Hello Mike,

On Friday 26 Feb 2010 00:24:29 Mike Christie wrote:
> On 02/25/2010 01:55 AM, Ritesh Raj Sarraf wrote:
> > From: Ritesh Raj Sarraf<[email protected]>
> 
> Thanks for the patches. Could you tell me what the "\" being added is
> for or supposed to do?
> 

lintian is a pretty helpful tool.

I: open-iscsi: hyphen-used-as-minus-sign 
usr/share/man/man8/iscsi_discovery.8.gz:16                         
N:                                                                              
                            
N:    This manual page seems to contain a hyphen where a minus sign was         
                            
N:    intended. By default, "-" chars are interpreted as hyphens (U+2010) by    
                            
N:    groff, not as minus signs (U+002D). Since options to programs use minus   
                            
N:    signs (U+002D), this means for example in UTF-8 locales that you cannot   
                            
N:    cut and paste options, nor search for them easily. The Debian groff       
                            
N:    package currently forces "-" to be interpreted as a minus sign due to     
                            
N:    the number of manual pages with this problem, but this is a               
                            
N:    Debian-specific modification and hopefully eventually can be removed.     
                            
N:                                                                              
                            
N:    "-" must be escaped ("\-") to be interpreted as minus. If you really      
                            
N:    intend a hyphen (normally you don't), write it as "\(hy" to emphasise     
                            
N:    that fact. See groff(7) and especially groff_char(7) for details, and     
                            
N:    also the thread starting with                                             
                            
N:    http://lists.debian.org/debian-devel/2003/debian-devel-200303/msg01481.h  
                            
N:    tml                                                                       
                            
N:                                                                              
                            
N:    If you use some tool that converts your documentation to groff format,    
                            
N:    this tag may indicate a bug in the tool. Some tools convert dashes of     
                            
N:    any kind to hyphens. The safe way of converting dashes is to convert      
                            
N:    them to "\-".                                                             
                            
N:                                                                              
                            
N:    Because this error can occur very often, Lintian shows only the first 10  
                            
N:    occurrences for each man page and give the number of suppressed           
                            
N:    occurrences. If you want to see all warnings, run Lintian with the        
                            
N:    -d/--debug option.                                                        
                            
N:                                                                              
                            
N:    Refer to the groff_char(7) manual page for details.                       
                            
N:                                                                              
                            
N:    Severity: wishlist, Certainty: possible                                   
                            
N:                                                                              
                            
I: open-iscsi: hyphen-used-as-minus-sign 
usr/share/man/man8/iscsi_discovery.8.gz:18                         
I: open-iscsi: hyphen-used-as-minus-sign 
usr/share/man/man8/iscsi_discovery.8.gz:38
I: open-iscsi: hyphen-used-as-minus-sign usr/share/man/man8/iscsiadm.8.gz:5
I: open-iscsi: hyphen-used-as-minus-sign usr/share/man/man8/iscsiadm.8.gz:6


Regards,
Ritesh
-- 
Ritesh Raj Sarraf
RESEARCHUT - http://www.researchut.com
"Necessity is the mother of invention."

Attachment: signature.asc
Description: This is a digitally signed message part.

Reply via email to