Helix SwarmHelix Swarm

Newlines.html

  • //
  • guest/
  • dimitry_andric/
  • revml/
  • main/
  • product/
  • Newlines.html #1
  • View
  • Commits
  • Open Download .zip Download (3 KB) 
  1. <html><head><title>VCP::Newlines - Newline, ^Z, and NULL handling in VCP</title></head><body><h1><a name="NAME">NAME
  2.  
  3. </a></h1><p>VCP::Newlines - Newline, ^Z, and NULL handling in VCP
  4.  
  5. <p><hr><h1><a name="DESCRIPTION">DESCRIPTION
  6.  
  7. </a></h1><p>Newlines can be a bear to debug, since most display programs hide the
  8. difference between <code>\r\n</code>, <code>\r</code>, and <code>\n</code> from you.
  9.  
  10. <p>VCP copes with newlines thusly:
  11.  
  12. <dl><dt><a name="1_"><strong><p>1.
  13.  
  14. </strong></a><dd>When reading/writing repositories (Cvs, Perforce, etc), it lets them sweat
  15. the details.
  16.  
  17. <dt><a name="2_"><strong><p>2.
  18.  
  19. </strong></a><dd>RevML text (non-binary) files always use single newline &quot;\n&quot; endings internally
  20. for both content and patches.  Due to XML handling, any &quot;\r\n&quot; or &quot;\r&quot;
  21. sequences that sneak in to an XML file get converted to &quot;\n&quot; anyway.
  22.  
  23. <dt><a name="3_"><strong><p>3.
  24.  
  25. </strong></a><dd>RevML binary files use an escape like &lt;char code=&quot;0x0d&quot;/&gt; to encode carriage
  26. returns and other character codes illegal in XML texts.
  27.  
  28. <dt><a name="4_"><strong><p>4.
  29.  
  30. </strong></a><dd><a href="Source/revml.html">VCP::Source::revml</a> can be asked to convert &quot;\n&quot; to &quot;\r\n&quot;
  31. on the fly in text files.  It never does this by default because most
  32. modern-day editors do the right thing (<code>notepad.exe</code> is *not* modern day :).
  33.  
  34. <dt><a name="5_"><strong><p>5.
  35.  
  36. </strong></a><dd><a href="Dest/revml.html">VCP::Dest::revml</a> always converts &quot;\r\n&quot; and &quot;\r&quot; in to &quot;\n&quot;
  37. for consistancy's sake, so the RevML file extracted on a Windows machine should
  38. be identical (or at least more nearly so) to one extracted on a Unix machine.
  39. The metadata might differ a bit, of course, but at least the content won't.
  40.  
  41. </dl><p>Embedded Control-Z characters <code>^Z</code> (ASCII 26) are passed through, as are
  42. embedded NULLs.  Both the diff and patch code are ^Z and NULL clean as well
  43. (unlike many).
  44.  
  45. <p><code>vcp</code> treats all files as binary files and uses it's own <code>\r\n</code> conversion
  46. routines specifically to be able to pass <code>^Z</code> through unmolested, since not
  47. passing things through can mess up both end users with loitering <code>^Z</code>
  48. characters and <code>vcp</code>'s checksums.
  49.  
  50. <p>If you think you have issues like these, see the document
  51. <a href="Maintenance.html">VCP::Maintenance</a> for some options and tools that can help
  52. when debugging.
  53.  
  54. <p><hr><i><font size="-1">Last updated: Fri Nov  8 13:07:23 2002</font></i></body></html>
# Change User Description Committed
#1 6118 Dimitry Andric Integ from //public/revml to //guest/dimitry_andric/revml/main. 17 years ago
//guest/perforce_software/revml/product/Newlines.html
#1 4311 alan_teague Initial versions of productization files and scripts.
All are draft
 quality submi...tted for review. «		 21 years ago