home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 2 / RISC_DISC_2.iso / pd_share / program / gnu / indent / !ReadMe next >
Encoding:
Text File  |  1995-03-13  |  3.7 KB  |  112 lines
  1. GNU Indent 1.9.1 RISC OS release notes   (Risc OS release 1.0 13-Mar-1995)
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Contents
  5. ~~~~~~~~
  6.  
  7. Binary Archive:
  8.  
  9.   Indent        - The indent application
  10.   Indent/pro    - A default profile
  11.   Indent/txt    - A plain text version of the indent(1) man page
  12.                   Updated by me to cover options not in the
  13.                   original man page.
  14.   COPYING       - GNU Public License (Source:GNU/COPYING)
  15.   NEWS          - GNU Release notes  (Source:GNU/COPYING)
  16.   README        - GNU ReadMe         (Source:GNU/COPYING)
  17.  
  18.   !ReadMe       - This file.
  19.  
  20.  
  21. Source Archive:
  22.   Source/       - Source and Makefiles for making indent
  23.   GNU/          - GNU Documents
  24.   Docs          - Plain text manual (updated version of manpage)
  25.   !Readme       - This file.
  26.  
  27.  
  28. Intro
  29. ~~~~~
  30. Indent is a rather good C source formatting program that I found while
  31. desparately trying to find a quick way of sorting a couple of megs of
  32. very badly formatted C source.
  33.  
  34. All credit for the availabilty of indent for RISC OS really belong withs
  35. the author of UnixLib, without which, I doubt I would have bothered to
  36. port it, and would have spent many hours manually formatting loads of C
  37. source code.
  38.  
  39. I have 'RISCOS-ized' it a little, and hopefully made it more generally
  40. useful.
  41.  
  42. Instalation
  43. ~~~~~~~~~~~
  44. Copy 'indent' into your library directory. The file indent/pro should be
  45. locatable either in the current directory, or elsewhere on File$Path.
  46.  
  47. Notes
  48. ~~~~~
  49. This file just covers differences between indent as described in
  50. 'indent_man' and the version as ported to RISC OS.
  51.  
  52. The preset options file for indent is called 'indent/pro' rather than
  53. 'indent.pro'. It must be placed in the same directory as 'indent'.
  54.  
  55. In this release, backup files are not implemented properly, so you
  56. should allways give an output file name - a liitle more 'RISCOS-izing'
  57. is needed.
  58.  
  59. indent/pro
  60. ~~~~~~~~~~
  61. This file is expected to be found in either the current directory, or
  62. elsewhere on file$path. If it does not exist, then default GNU Style
  63. options are used.
  64.  
  65. Little is said in the GNU documentation about the format of this file,
  66. but it seems to be just a list of command options, one per line.
  67. Personally, I am tempted enhance the format so that it become more like
  68. a script, allowing options to be commented out, and more usefully, allow
  69. a quick reference quide to the options to be kept in this file.
  70.  
  71.  
  72. Compiling the Source
  73. ~~~~~~~~~~~~~~~~~~~~
  74. First of all, you need to have UnixLib.
  75.  
  76. I compiled this with a developer only version of an Acorn C compiler as 
  77. the first compiler I tried took a very long time to compile indent.c,
  78. and then the linker crashed when trying to link it.
  79.  
  80. Re-linking with a later version of link seemed OK.
  81.  
  82. As a consequence, I decided to re-compile the lot with the compiler that
  83. came with the linker that worked.
  84.  
  85. Hopefully, being GNU source, you shouldn't have any problems compiling
  86. with the GNU compiler.
  87.  
  88.  
  89. To be done
  90. ~~~~~~~~~~
  91. Add proper Acorn DDE support for extended command lines.
  92. Provide a DDE wimp front end.
  93. Provide throwback support for warnings.
  94.  
  95. Items of Interest
  96. ~~~~~~~~~~~~~~~~~
  97. Apparently someone is writing a program called 'review' thgat is
  98. supposed to examine your source code, and attempt to set options that
  99. match your style of coding. As yet, I havnt been able to locate this
  100. program, bit when I do, it will make a very useful companion to indent.
  101.  
  102. Upgrades
  103. ~~~~~~~~
  104. As and when these become available, and I become aware of their
  105. existance, then the RISC OS version will soon follow. If you find a
  106. later versin than 1.9.1, please let me know in case I have missed it.
  107.  
  108. ----------------------------------------
  109. Adam Goodfellow (13-Mar-1995)
  110.  
  111. I can be contacted via email to adam@comptech.demon.co.uk.
  112.