Post by thread:[OT]: - Firmware Maintenance Templates/Procedures

(Fixed the subject line, needed a colon after [OT].) One thing I've seen that I mostly liked, in past, was in aviation safety systems - the documentation was installed inside the source (.asm) files. IMO this is a good idea - This way the programmers could actually get at & see the docs, and were in fact in charge of the documentation's upkeep and maintenance (gasp!) - SO often, it's marketing or someone who knows nothing about the code, who writes the manual etc., months later, with no clue - And it ends up resembling the code's behavior SO little, that it's rather pathetic. They had a tool that'd extract the docs into a file that the documentation people were allowed to get at, then had a nice tool that re-formatted that text file into a properly formatted document. Nowadays, HTML comes to mind <G> Probably could treat it as a separate "source code" file, and not include it directly into the code. And the extract document "compiled" (checked syntax) as a matter of course so you couldn't "oops" without noticing, well, not too badly anyways. And of course you could verify that you didn't mess up the code when the docs were changed (compare the previous .obj files with current freshly compiled version, should be identical) - twas on a Z80/80186 dual processor machine. You already know about concepts like bug report filing, bug verification, change control boards, regression testing, and so on, I'll assume, if you've seen what NASA has to offer. (IMO some co's go way overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", I always feel my competence is being insulted, frankly. Now, "If we let management make decisions, it'll just encourage them", that definitely has truth to it, for some values of management <G>) Treat it like any other system, look for gaping holes, and design something that's able to cope with your organizations needs. Mark D Lloyd wrote: {Quote hidden}> Hi PICsters, > > As we all know that documentation of code is very important and that we all > *religiously* follow our procedures <cough, cough>, does anyone know of any good > templates regarding maintenance as opposed to development? > > Such templates would ideally relate to change control procedures, bug > maintenance etc. I went through the same exercise of obtaining such information > for development but procedures used by the likes of NASA are a bit overkill for > general embedded systems, so cut down information would be more beneficial. > > Any help/useful pointers would be appreciated. > > Kind Regards, > Dan Lloyd > > Firmware Engineer, Electronic Operations > ABB Metering. England. -- I re-ship for small US & overseas businesses, world-wide. (For private individuals at cost; ask.)

Along those lines, here is an assembly file marked up with enough HTML to display properly in a browser... (Small attachment! Don't shoot me!) It is an htm file so that I can simply click on it and see the document. MPLAB does care what extension a file has so I provided an extra language tool file and modified microchip's language tool suite file to accept htm files. (mpasm.mtc --> mpasmhtm.mtc with some modification and modified TLMCHIP.INI). I then installed my new language tool "MPASM(*.htm)" and now I can include htm files as nodes in a project and assemble them under mplab. -Adam "Get the facts first, you can distort them later" - Mark Twain Mark Willis wrote: {Quote hidden}> > (Fixed the subject line, needed a colon after [OT].) > > One thing I've seen that I mostly liked, in past, was in aviation safety > systems - the documentation was installed inside the source (.asm) > files. > > IMO this is a good idea - This way the programmers could actually get at > & see the docs, and were in fact in charge of the documentation's upkeep > and maintenance (gasp!) - SO often, it's marketing or someone who knows > nothing about the code, who writes the manual etc., months later, with > no clue - And it ends up resembling the code's behavior SO little, that > it's rather pathetic. > > They had a tool that'd extract the docs into a file that the > documentation people were allowed to get at, then had a nice tool that > re-formatted that text file into a properly formatted document. > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > "source code" file, and not include it directly into the code. And the > extract document "compiled" (checked syntax) as a matter of course so > you couldn't "oops" without noticing, well, not too badly anyways. > > And of course you could verify that you didn't mess up the code when the > docs were changed (compare the previous .obj files with current freshly > compiled version, should be identical) - twas on a Z80/80186 dual > processor machine. > > You already know about concepts like bug report filing, bug > verification, change control boards, regression testing, and so on, I'll > assume, if you've seen what NASA has to offer. (IMO some co's go way > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > I always feel my competence is being insulted, frankly. Now, "If we let > management make decisions, it'll just encourage them", that definitely > has truth to it, for some values of management <G>) Treat it like any > other system, look for gaping holes, and design something that's able to > cope with your organizations needs. > > Mark > > D Lloyd wrote: > > Hi PICsters, > > > > As we all know that documentation of code is very important and that we all > > *religiously* follow our procedures <cough, cough>, does anyone know of any good > > templates regarding maintenance as opposed to development? > > > > Such templates would ideally relate to change control procedures, bug > > maintenance etc. I went through the same exercise of obtaining such information > > for development but procedures used by the likes of NASA are a bit overkill for > > general embedded systems, so cut down information would be more beneficial. > > > > Any help/useful pointers would be appreciated. > > > > Kind Regards, > > Dan Lloyd > > > > Firmware Engineer, Electronic Operations > > ABB Metering. England. > > -- > I re-ship for small US & overseas businesses, world-wide. > (For private individuals at cost; ask.)

Hmm... It appears as though my attachment didn't go through... Go to http://www.ubasics.com/adam/pic/doc to see the files asmfile.htm The html formatted assembly file TLMCHIP.INI The modified language suite file for mchip (use it to replace tlmchip.ini) MPASMhtm.MTC The modified MPASM.MTC file (use it in addition with mpasm.mtc) After copying the language files to your mplab directory, choose 'install language tools' from the project menu. Under the microchip lanuage tools, there will ba an additional language, "MPASM(*.htm)". Select that, and put in the path to your mpasmwin.exe file. -Adam "M. Adam Davis" wrote: {Quote hidden}> > Along those lines, here is an assembly file marked up with enough HTML to > display properly in a browser... (Small attachment! Don't shoot me!) > > It is an htm file so that I can simply click on it and see the document. MPLAB > does care what extension a file has so I provided an extra language tool file > and modified microchip's language tool suite file to accept htm files. > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified TLMCHIP.INI). I > then installed my new language tool "MPASM(*.htm)" and now I can include htm > files as nodes in a project and assemble them under mplab. > > -Adam > > "Get the facts first, you can distort them later" - Mark Twain > > Mark Willis wrote: > > > > (Fixed the subject line, needed a colon after [OT].) > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > systems - the documentation was installed inside the source (.asm) > > files. > > > > IMO this is a good idea - This way the programmers could actually get at > > & see the docs, and were in fact in charge of the documentation's upkeep > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > nothing about the code, who writes the manual etc., months later, with > > no clue - And it ends up resembling the code's behavior SO little, that > > it's rather pathetic. > > > > They had a tool that'd extract the docs into a file that the > > documentation people were allowed to get at, then had a nice tool that > > re-formatted that text file into a properly formatted document. > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > "source code" file, and not include it directly into the code. And the > > extract document "compiled" (checked syntax) as a matter of course so > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > And of course you could verify that you didn't mess up the code when the > > docs were changed (compare the previous .obj files with current freshly > > compiled version, should be identical) - twas on a Z80/80186 dual > > processor machine. > > > > You already know about concepts like bug report filing, bug > > verification, change control boards, regression testing, and so on, I'll > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > I always feel my competence is being insulted, frankly. Now, "If we let > > management make decisions, it'll just encourage them", that definitely > > has truth to it, for some values of management <G>) Treat it like any > > other system, look for gaping holes, and design something that's able to > > cope with your organizations needs. > > > > Mark > > > > D Lloyd wrote: > > > Hi PICsters, > > > > > > As we all know that documentation of code is very important and that we all > > > *religiously* follow our procedures <cough, cough>, does anyone know of any good > > > templates regarding maintenance as opposed to development? > > > > > > Such templates would ideally relate to change control procedures, bug > > > maintenance etc. I went through the same exercise of obtaining such information > > > for development but procedures used by the likes of NASA are a bit overkill for > > > general embedded systems, so cut down information would be more beneficial. > > > > > > Any help/useful pointers would be appreciated. > > > > > > Kind Regards, > > > Dan Lloyd > > > > > > Firmware Engineer, Electronic Operations > > > ABB Metering. England. > > > > -- > > I re-ship for small US & overseas businesses, world-wide. > > (For private individuals at cost; ask.)

part 0 6117 bytes content-type:application/octet-stream;Hi, This is a *nice* idea - thanks. Fits in nicely with our philosophy of "intranet-ising" everything. I'll have a bash at this with some of our *.c files (asm? what's that? <grin>); have to see if I can frig the compiler to ignore the html. Dan |-------------> |(Embedded | |image moved | |to file: | |pic20839.pcx)| | | |-------------> >------------------------------------------------------------------------| |"M. Adam Davis" <RemoveMEadavisTakeThisOuTUBASICS.COM> | |01/06/2000 21:03 | >------------------------------------------------------------------------| Please respond to pic microcontroller discussion list <spamBeGonePICLISTspamBeGoneMITVMA.MIT.EDU> To: TakeThisOuTPICLISTEraseMEspam_OUTMITVMA.MIT.EDU cc: (bcc: Dan Lloyd/GBPTD/ABB) Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures Security Level:? Internal Hmm... It appears as though my attachment didn't go through... Go to http://www.ubasics.com/adam/pic/doc to see the files asmfile.htm The html formatted assembly file TLMCHIP.INI The modified language suite file for mchip (use it to replace tlmchip.ini) MPASMhtm.MTC The modified MPASM.MTC file (use it in addition with mpasm.mtc) After copying the language files to your mplab directory, choose 'install language tools' from the project menu. Under the microchip lanuage tools, there will ba an additional language, "MPASM(*.htm)". Select that, and put in the path to your mpasmwin.exe file. -Adam "M. Adam Davis" wrote: > > Along those lines, here is an assembly file marked up with enough HTML to > display properly in a browser... (Small attachment! Don't shoot me!) > > It is an htm file so that I can simply click on it and see the document. MPLAB {Quote hidden}> does care what extension a file has so I provided an extra language tool file > and modified microchip's language tool suite file to accept htm files. > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified TLMCHIP.INI). I > then installed my new language tool "MPASM(*.htm)" and now I can include htm > files as nodes in a project and assemble them under mplab. > > -Adam > > "Get the facts first, you can distort them later" - Mark Twain > > Mark Willis wrote: > > > > (Fixed the subject line, needed a colon after [OT].) > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > systems - the documentation was installed inside the source (.asm) > > files. > > > > IMO this is a good idea - This way the programmers could actually get at > > & see the docs, and were in fact in charge of the documentation's upkeep > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > nothing about the code, who writes the manual etc., months later, with > > no clue - And it ends up resembling the code's behavior SO little, that > > it's rather pathetic. > > > > They had a tool that'd extract the docs into a file that the > > documentation people were allowed to get at, then had a nice tool that > > re-formatted that text file into a properly formatted document. > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > "source code" file, and not include it directly into the code. And the > > extract document "compiled" (checked syntax) as a matter of course so > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > And of course you could verify that you didn't mess up the code when the > > docs were changed (compare the previous .obj files with current freshly > > compiled version, should be identical) - twas on a Z80/80186 dual > > processor machine. > > > > You already know about concepts like bug report filing, bug > > verification, change control boards, regression testing, and so on, I'll > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > I always feel my competence is being insulted, frankly. Now, "If we let > > management make decisions, it'll just encourage them", that definitely > > has truth to it, for some values of management <G>) Treat it like any > > other system, look for gaping holes, and design something that's able to > > cope with your organizations needs. > > > > Mark > > > > D Lloyd wrote: > > > Hi PICsters, > > > > > > As we all know that documentation of code is very important and that we all > > > *religiously* follow our procedures <cough, cough>, does anyone know of any good > > > templates regarding maintenance as opposed to development? > > > > > > Such templates would ideally relate to change control procedures, bug > > > maintenance etc. I went through the same exercise of obtaining such information > > > for development but procedures used by the likes of NASA are a bit overkill for > > > general embedded systems, so cut down information would be more beneficial. {Quote hidden}> > > > > > Any help/useful pointers would be appreciated. > > > > > > Kind Regards, > > > Dan Lloyd > > > > > > Firmware Engineer, Electronic Operations > > > ABB Metering. England. > > > > -- > > I re-ship for small US & overseas businesses, world-wide. > > (For private individuals at cost; ask.) Content-type: application/octet-stream; name="pic20839.pcx" Content-Disposition: attachment; filename="pic20839.pcx" Attachment converted: creation:pic20839.pcx (????/----) (00016053)

Just do /* <HTML><BODY><TITLE>This Darn C Program</TITLE><pre> Program Creator Date ... (no HTML code needed to format this area, it appears as it is written in the browser, and is less cluttered for the programmer to deal with) ... </pre><!- */ void main(void) { ... w=0xff; // ->This line needs a special comment in the docs<!- } /* This program does nothing, and is useless Blah, blah blah</> ... </BODY></HTML> */ Since there is no 'end' directive to tell the compiler to stop looking, you have to put all the HTML in comments. Unfortunately, my mailer may get rid of the HTML tags before it is sent. If you don't see anything usefull above, go to http://www.ubasics.com/adam/pic/doc/ and look for cfile.htm. You'll need to add a new C language, as well. -Adam D Lloyd wrote: {Quote hidden}> > Hi, > > This is a *nice* idea - thanks. Fits in nicely with our philosophy of > "intranet-ising" everything. > I'll have a bash at this with some of our *.c files (asm? what's that? <grin>); > have to see if I can frig the compiler to ignore the html. > > Dan > > |-------------> > |(Embedded | > |image moved | > |to file: | > |pic20839.pcx)| > | | > |-------------> > >------------------------------------------------------------------------| > |"M. Adam Davis" <EraseMEadavisUBASICS.COM> | > |01/06/2000 21:03 | > >------------------------------------------------------------------------| > > Please respond to pic microcontroller discussion list <RemoveMEPICLISTEraseMEEraseMEMITVMA.MIT.EDU> > > To: RemoveMEPICLISTspam_OUTKILLspamMITVMA.MIT.EDU > cc: (bcc: Dan Lloyd/GBPTD/ABB) > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > Security Level:? Internal > > Hmm... It appears as though my attachment didn't go through... > > Go to http://www.ubasics.com/adam/pic/doc to see the files > asmfile.htm The html formatted assembly file > TLMCHIP.INI The modified language suite file for mchip > (use it to replace tlmchip.ini) > MPASMhtm.MTC The modified MPASM.MTC file > (use it in addition with mpasm.mtc) > > After copying the language files to your mplab directory, choose 'install > language tools' from the project menu. Under the microchip lanuage tools, there > will ba an additional language, "MPASM(*.htm)". Select that, and put in the > path to your mpasmwin.exe file. > > -Adam > > "M. Adam Davis" wrote: > > > > Along those lines, here is an assembly file marked up with enough HTML to > > display properly in a browser... (Small attachment! Don't shoot me!) > > > > It is an htm file so that I can simply click on it and see the document. > MPLAB > > does care what extension a file has so I provided an extra language tool file > > and modified microchip's language tool suite file to accept htm files. > > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified TLMCHIP.INI). > I > > then installed my new language tool "MPASM(*.htm)" and now I can include htm > > files as nodes in a project and assemble them under mplab. > > > > -Adam > > > > "Get the facts first, you can distort them later" - Mark Twain > > > > Mark Willis wrote: > > > > > > (Fixed the subject line, needed a colon after [OT].) > > > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > > systems - the documentation was installed inside the source (.asm) > > > files. > > > > > > IMO this is a good idea - This way the programmers could actually get at > > > & see the docs, and were in fact in charge of the documentation's upkeep > > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > > nothing about the code, who writes the manual etc., months later, with > > > no clue - And it ends up resembling the code's behavior SO little, that > > > it's rather pathetic. > > > > > > They had a tool that'd extract the docs into a file that the > > > documentation people were allowed to get at, then had a nice tool that > > > re-formatted that text file into a properly formatted document. > > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > > "source code" file, and not include it directly into the code. And the > > > extract document "compiled" (checked syntax) as a matter of course so > > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > > > And of course you could verify that you didn't mess up the code when the > > > docs were changed (compare the previous .obj files with current freshly > > > compiled version, should be identical) - twas on a Z80/80186 dual > > > processor machine. > > > > > > You already know about concepts like bug report filing, bug > > > verification, change control boards, regression testing, and so on, I'll > > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > > I always feel my competence is being insulted, frankly. Now, "If we let > > > management make decisions, it'll just encourage them", that definitely > > > has truth to it, for some values of management <G>) Treat it like any > > > other system, look for gaping holes, and design something that's able to > > > cope with your organizations needs. > > > > > > Mark > > > > > > D Lloyd wrote: > > > > Hi PICsters, > > > > > > > > As we all know that documentation of code is very important and that we > all > > > > *religiously* follow our procedures <cough, cough>, does anyone know of > any good > > > > templates regarding maintenance as opposed to development? > > > > > > > > Such templates would ideally relate to change control procedures, bug > > > > maintenance etc. I went through the same exercise of obtaining such > information > > > > for development but procedures used by the likes of NASA are a bit > overkill for > > > > general embedded systems, so cut down information would be more > beneficial. > > > > > > > > Any help/useful pointers would be appreciated. > > > > > > > > Kind Regards, > > > > Dan Lloyd > > > > > > > > Firmware Engineer, Electronic Operations > > > > ABB Metering. England. > > > > > > -- > > > I re-ship for small US & overseas businesses, world-wide. > > > (For private individuals at cost; ask.) > > -------------------------------------------------------------------------------- > Name: pic20839.pcx > pic20839.pcx Type: PCX Image (application/x-unknown-content-type-pcxfile) > Encoding: base64

Mark Willis wrote: > Yes, that's right. Well, they're enabled, then; I know we were > discussing the capability (Maybe Mike was going to gripe at L-Soft about > getting that feature ADDED?) It's been an interesting day <G> It's mentioned in the docs as a feature in a version newer than what our server is running. After the next system upgrade at MIT, I guess ... {Quote hidden}> Usually best for longer attachments to throw them on a web page, of > course. For short ones, inline's fine (50 lines, say?) > > Mark > > M. Adam Davis wrote: > > Well, there's a certian .pcx file that has been found on a few other messages, > > probably lotus software attaching some sort of card or something... see D Lloyd > > <RemoveMEdan.lloydTakeThisOuTspamGB.ABB.COM> 's posts. So I didn't even think about the idea that the > > list might've taken care of it. I thought my computer messed it up... I've been wondering for some time now ... what *is* that .pcx thing anyway? I tried taking a look at it to see if I could at least figure out what *type* of file it was - i.e. a graphic, some sort of v-card, etc. - but no luck. > > But, I'm all for not allowing attachments on the list. It would be nice, > > however, to receive a message if my posting is altered in any way (ie, adding a > > topic, deleting the attachment, etc)... But I suppose there are some people who > > can't turn off certian attachments (due to work policies, perhaps?) such as > > vcard, which would be a pain for them to post and get a message back about their > > deleted attachment every time... It's been discussed. Last I remember there wasn't quite a decision made. There is something to be said about being able to attach code snips and such to a message, or a graphic showing a circuit under question. However it can also be argued that with the proliferation of free web space providers that it is better to simply put the item onto a web page and post the URL. As for how the server would go about denying attachments, it can do it in a few different ways (once we get the version with that capability, that is). It can either: 1) Bounce the message back to the sender outright 2) Strip the attachments and send the message on through, with no warning to the sender. If we were to implement this, I would guess (and this is *just* a guess) that it would be the second option that would get implemented. > > Mark Willis wrote: > > > > > > I thought Mike W. set the list to kill attachments? Am I recalling > > > inaccurately? (wouldn't be the first time, o'course.) Currently, the only attachment type that we *can* kill is HTML attachments. And *that* is why Adam's HTMLized asm attachment didn't come through. The server saw an attachment with MIME type text/html and stripped it off. -- Mike Werner KA8YSD | "Where do you want to go today?" | "As far from Redmond as possible!" '91 GS500E | Morgantown WV | Only dead fish go with the flow.

Thought of another thing for a list autoresponder to handle, BTW: Have it handle "Your clock's WAY off!" posts to those people on Betelguesian time <G>) Mike Werner wrote: > Mark Willis wrote: > > Yes, that's right. Well, they're enabled, then; I know we were > > discussing the capability (Maybe Mike was going to gripe at L-Soft about > > getting that feature ADDED?) It's been an interesting day <G> > > It's mentioned in the docs as a feature in a version newer than what our > server is running. After the next system upgrade at MIT, I guess ... When they do it, they won't tell us, either (never have in the past.) We'll cope. {Quote hidden}> > Usually best for longer attachments to throw them on a web page, of > > course. For short ones, inline's fine (50 lines, say?) > > > > Mark > > > > M. Adam Davis wrote: > > > Well, there's a certian .pcx file that has been found on a few other messages, > > > probably lotus software attaching some sort of card or something... see D Lloyd > > > <EraseMEdan.lloydspamspamBeGoneGB.ABB.COM> 's posts. So I didn't even think about the idea that the > > > list might've taken care of it. I thought my computer messed it up... > > I've been wondering for some time now ... what *is* that .pcx thing anyway? > I tried taking a look at it to see if I could at least figure out what *type* > of file it was - i.e. a graphic, some sort of v-card, etc. - but no luck. It's not getting here as a valid PCX file either. Supposed to be a company logo - Why someone'd set it up to devour bandwidth, must be yet another pointy-haired choice <G> {Quote hidden}> > > But, I'm all for not allowing attachments on the list. It would be nice, > > > however, to receive a message if my posting is altered in any way (ie, adding a > > > topic, deleting the attachment, etc)... But I suppose there are some people who > > > can't turn off certian attachments (due to work policies, perhaps?) such as > > > vcard, which would be a pain for them to post and get a message back about their > > > deleted attachment every time... > > It's been discussed. Last I remember there wasn't quite a decision made. > There is something to be said about being able to attach code snips and > such to a message, or a graphic showing a circuit under question. However > it can also be argued that with the proliferation of free web space providers > that it is better to simply put the item onto a web page and post the URL. > > As for how the server would go about denying attachments, it can do it in > a few different ways (once we get the version with that capability, that > is). It can either: > 1) Bounce the message back to the sender outright > 2) Strip the attachments and send the message on through, with no warning to > the sender. > If we were to implement this, I would guess (and this is *just* a guess) that > it would be the second option that would get implemented. I've been thinking on all this - I think if someone had a list processor daemon machine that'd do what we want, we could probably handle things like making people custom digests (that're actually RFC compliant), that have filtering handled; The same autoresponder machine could add that, though anti-SPAM people at that ISP would have to be told about it. It's a thought. > > > Mark Willis wrote: > > > > > > > > I thought Mike W. set the list to kill attachments? Am I recalling > > > > inaccurately? (wouldn't be the first time, o'course.) > > Currently, the only attachment type that we *can* kill is HTML attachments. > And *that* is why Adam's HTMLized asm attachment didn't come through. The > server saw an attachment with MIME type text/html and stripped it off. Me confoozled, happens. > -- > Mike Werner KA8YSD | "Where do you want to go today?" > | "As far from Redmond as possible!" > '91 GS500E | > Morgantown WV | Only dead fish go with the flow. Mark

part 0 8952 bytes content-type:application/octet-stream;Hi I did something along the lines of this but certain variable names, followed by '>' (such as in tests), were interpreted as html control codes. I didn't really want to be putting control codes all over the place but I'll endeavour to get this working! Regards, Dan |-------------> |(Embedded | |image moved | |to file: | |pic12499.pcx)| | | |-------------> >------------------------------------------------------------------------| |"M. Adam Davis" <RemoveMEadavisKILLspamUBASICS.COM> | |02/06/2000 13:45 | >------------------------------------------------------------------------| Please respond to pic microcontroller discussion list <PICLISTSTOPspamspam_OUTMITVMA.MIT.EDU> To: spamBeGonePICLISTSTOPspamEraseMEMITVMA.MIT.EDU cc: (bcc: Dan Lloyd/GBPTD/ABB) Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures Security Level:? Internal Just do /* <HTML><BODY><TITLE>This Darn C Program</TITLE><pre> Program Creator Date ... (no HTML code needed to format this area, it appears as it is written in the browser, and is less cluttered for the programmer to deal with) ... </pre><!- */ void main(void) { ... w=0xff; // ->This line needs a special comment in the docs<!- } /* This program does nothing, and is useless Blah, blah blah</> ... </BODY></HTML> */ Since there is no 'end' directive to tell the compiler to stop looking, you have to put all the HTML in comments. Unfortunately, my mailer may get rid of the HTML tags before it is sent. If you don't see anything usefull above, go to http://www.ubasics.com/adam/pic/doc/ and look for cfile.htm. You'll need to add a new C language, as well. -Adam D Lloyd wrote: > > Hi, > > This is a *nice* idea - thanks. Fits in nicely with our philosophy of > "intranet-ising" everything. > I'll have a bash at this with some of our *.c files (asm? what's that? <grin>); {Quote hidden}> have to see if I can frig the compiler to ignore the html. > > Dan > > |-------------> > |(Embedded | > |image moved | > |to file: | > |pic20839.pcx)| > | | > |-------------> > >------------------------------------------------------------------------| > |"M. Adam Davis" <KILLspamadavisspamBeGoneUBASICS.COM> | > |01/06/2000 21:03 | > >------------------------------------------------------------------------| > > Please respond to pic microcontroller discussion list <EraseMEPICLISTEraseMEMITVMA.MIT.EDU> > > To: @spam@PICLIST@spam@spam_OUTMITVMA.MIT.EDU > cc: (bcc: Dan Lloyd/GBPTD/ABB) > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > Security Level:? Internal > > Hmm... It appears as though my attachment didn't go through... > > Go to http://www.ubasics.com/adam/pic/doc to see the files > asmfile.htm The html formatted assembly file > TLMCHIP.INI The modified language suite file for mchip > (use it to replace tlmchip.ini) > MPASMhtm.MTC The modified MPASM.MTC file > (use it in addition with mpasm.mtc) > > After copying the language files to your mplab directory, choose 'install > language tools' from the project menu. Under the microchip lanuage tools, there {Quote hidden}> will ba an additional language, "MPASM(*.htm)". Select that, and put in the > path to your mpasmwin.exe file. > > -Adam > > "M. Adam Davis" wrote: > > > > Along those lines, here is an assembly file marked up with enough HTML to > > display properly in a browser... (Small attachment! Don't shoot me!) > > > > It is an htm file so that I can simply click on it and see the document. > MPLAB > > does care what extension a file has so I provided an extra language tool file > > and modified microchip's language tool suite file to accept htm files. > > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified TLMCHIP.INI). {Quote hidden}> I > > then installed my new language tool "MPASM(*.htm)" and now I can include htm > > files as nodes in a project and assemble them under mplab. > > > > -Adam > > > > "Get the facts first, you can distort them later" - Mark Twain > > > > Mark Willis wrote: > > > > > > (Fixed the subject line, needed a colon after [OT].) > > > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > > systems - the documentation was installed inside the source (.asm) > > > files. > > > > > > IMO this is a good idea - This way the programmers could actually get at > > > & see the docs, and were in fact in charge of the documentation's upkeep > > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > > nothing about the code, who writes the manual etc., months later, with > > > no clue - And it ends up resembling the code's behavior SO little, that > > > it's rather pathetic. > > > > > > They had a tool that'd extract the docs into a file that the > > > documentation people were allowed to get at, then had a nice tool that > > > re-formatted that text file into a properly formatted document. > > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > > "source code" file, and not include it directly into the code. And the > > > extract document "compiled" (checked syntax) as a matter of course so > > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > > > And of course you could verify that you didn't mess up the code when the > > > docs were changed (compare the previous .obj files with current freshly > > > compiled version, should be identical) - twas on a Z80/80186 dual > > > processor machine. > > > > > > You already know about concepts like bug report filing, bug > > > verification, change control boards, regression testing, and so on, I'll > > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > > I always feel my competence is being insulted, frankly. Now, "If we let > > > management make decisions, it'll just encourage them", that definitely > > > has truth to it, for some values of management <G>) Treat it like any > > > other system, look for gaping holes, and design something that's able to > > > cope with your organizations needs. > > > > > > Mark > > > > > > D Lloyd wrote: > > > > Hi PICsters, > > > > > > > > As we all know that documentation of code is very important and that we > all > > > > *religiously* follow our procedures <cough, cough>, does anyone know of > any good > > > > templates regarding maintenance as opposed to development? > > > > > > > > Such templates would ideally relate to change control procedures, bug > > > > maintenance etc. I went through the same exercise of obtaining such > information > > > > for development but procedures used by the likes of NASA are a bit > overkill for > > > > general embedded systems, so cut down information would be more > beneficial. > > > > > > > > Any help/useful pointers would be appreciated. > > > > > > > > Kind Regards, > > > > Dan Lloyd > > > > > > > > Firmware Engineer, Electronic Operations > > > > ABB Metering. England. > > > > > > -- > > > I re-ship for small US & overseas businesses, world-wide. > > > (For private individuals at cost; ask.) > > -------------------------------------------------------------------------------- > Name: pic20839.pcx > pic20839.pcx Type: PCX Image (application/x-unknown-content-type-pcxfile) > Encoding: base64 Content-type: application/octet-stream; name="pic12499.pcx" Content-Disposition: attachment; filename="pic12499.pcx" Attachment converted: creation:pic12499.pcx (????/----) (0001613B)

part 0 8954 bytes content-type:application/octet-stream;Hi I did something along the lines of this but certain variable names, followed by '>' (such as in tests), were interpreted as html control codes. I didn't really want to be putting control codes all over the place but I'll endeavour to get this working! Regards, Dan |-------------> |(Embedded | |image moved | |to file: | |pic12499.pcx)| | | |-------------> >------------------------------------------------------------------------| |"M. Adam Davis" <spamBeGoneadavisKILLspamUBASICS.COM> | |02/06/2000 13:45 | >------------------------------------------------------------------------| Please respond to pic microcontroller discussion list <.....PICLISTspam_OUTMITVMA.MIT.EDU> To: TakeThisOuTPICLIST.....TakeThisOuTMITVMA.MIT.EDU cc: (bcc: Dan Lloyd/GBPTD/ABB) Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures Security Level:? Internal Just do /* <HTML><BODY><TITLE>This Darn C Program</TITLE><pre> Program Creator Date ... (no HTML code needed to format this area, it appears as it is written in the browser, and is less cluttered for the programmer to deal with) ... </pre><!- */ void main(void) { ... w=0xff; // ->This line needs a special comment in the docs<!- } /* This program does nothing, and is useless Blah, blah blah</> ... </BODY></HTML> */ Since there is no 'end' directive to tell the compiler to stop looking, you have to put all the HTML in comments. Unfortunately, my mailer may get rid of the HTML tags before it is sent. If you don't see anything usefull above, go to http://www.ubasics.com/adam/pic/doc/ and look for cfile.htm. You'll need to add a new C language, as well. -Adam D Lloyd wrote: > > Hi, > > This is a *nice* idea - thanks. Fits in nicely with our philosophy of > "intranet-ising" everything. > I'll have a bash at this with some of our *.c files (asm? what's that? <grin>); {Quote hidden}> have to see if I can frig the compiler to ignore the html. > > Dan > > |-------------> > |(Embedded | > |image moved | > |to file: | > |pic20839.pcx)| > | | > |-------------> > >------------------------------------------------------------------------| > |"M. Adam Davis" <TakeThisOuTadavisKILLspamspamUBASICS.COM> | > |01/06/2000 21:03 | > >------------------------------------------------------------------------| > > Please respond to pic microcontroller discussion list <.....PICLISTRemoveMEMITVMA.MIT.EDU> > > To: RemoveMEPICLISTspamBeGoneMITVMA.MIT.EDU > cc: (bcc: Dan Lloyd/GBPTD/ABB) > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > Security Level:? Internal > > Hmm... It appears as though my attachment didn't go through... > > Go to http://www.ubasics.com/adam/pic/doc to see the files > asmfile.htm The html formatted assembly file > TLMCHIP.INI The modified language suite file for mchip > (use it to replace tlmchip.ini) > MPASMhtm.MTC The modified MPASM.MTC file > (use it in addition with mpasm.mtc) > > After copying the language files to your mplab directory, choose 'install > language tools' from the project menu. Under the microchip lanuage tools, there {Quote hidden}> will ba an additional language, "MPASM(*.htm)". Select that, and put in the > path to your mpasmwin.exe file. > > -Adam > > "M. Adam Davis" wrote: > > > > Along those lines, here is an assembly file marked up with enough HTML to > > display properly in a browser... (Small attachment! Don't shoot me!) > > > > It is an htm file so that I can simply click on it and see the document. > MPLAB > > does care what extension a file has so I provided an extra language tool file > > and modified microchip's language tool suite file to accept htm files. > > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified TLMCHIP.INI). {Quote hidden}> I > > then installed my new language tool "MPASM(*.htm)" and now I can include htm > > files as nodes in a project and assemble them under mplab. > > > > -Adam > > > > "Get the facts first, you can distort them later" - Mark Twain > > > > Mark Willis wrote: > > > > > > (Fixed the subject line, needed a colon after [OT].) > > > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > > systems - the documentation was installed inside the source (.asm) > > > files. > > > > > > IMO this is a good idea - This way the programmers could actually get at > > > & see the docs, and were in fact in charge of the documentation's upkeep > > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > > nothing about the code, who writes the manual etc., months later, with > > > no clue - And it ends up resembling the code's behavior SO little, that > > > it's rather pathetic. > > > > > > They had a tool that'd extract the docs into a file that the > > > documentation people were allowed to get at, then had a nice tool that > > > re-formatted that text file into a properly formatted document. > > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > > "source code" file, and not include it directly into the code. And the > > > extract document "compiled" (checked syntax) as a matter of course so > > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > > > And of course you could verify that you didn't mess up the code when the > > > docs were changed (compare the previous .obj files with current freshly > > > compiled version, should be identical) - twas on a Z80/80186 dual > > > processor machine. > > > > > > You already know about concepts like bug report filing, bug > > > verification, change control boards, regression testing, and so on, I'll > > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > > I always feel my competence is being insulted, frankly. Now, "If we let > > > management make decisions, it'll just encourage them", that definitely > > > has truth to it, for some values of management <G>) Treat it like any > > > other system, look for gaping holes, and design something that's able to > > > cope with your organizations needs. > > > > > > Mark > > > > > > D Lloyd wrote: > > > > Hi PICsters, > > > > > > > > As we all know that documentation of code is very important and that we > all > > > > *religiously* follow our procedures <cough, cough>, does anyone know of > any good > > > > templates regarding maintenance as opposed to development? > > > > > > > > Such templates would ideally relate to change control procedures, bug > > > > maintenance etc. I went through the same exercise of obtaining such > information > > > > for development but procedures used by the likes of NASA are a bit > overkill for > > > > general embedded systems, so cut down information would be more > beneficial. > > > > > > > > Any help/useful pointers would be appreciated. > > > > > > > > Kind Regards, > > > > Dan Lloyd > > > > > > > > Firmware Engineer, Electronic Operations > > > > ABB Metering. England. > > > > > > -- > > > I re-ship for small US & overseas businesses, world-wide. > > > (For private individuals at cost; ask.) > > -------------------------------------------------------------------------------- > Name: pic20839.pcx > pic20839.pcx Type: PCX Image (application/x-unknown-content-type-pcxfile) > Encoding: base64 Content-type: application/octet-stream; name="pic12499.pcx" Content-Disposition: attachment; filename="pic12499.pcx" Attachment converted: creation:pic12499.pcx 1 (????/----) (00016184)

hmm... As long as you don't have a '->' in the code, it shouldn't end the html comment tag '<!- ..... ->' -Adam D Lloyd wrote: {Quote hidden}> > Hi > > I did something along the lines of this but certain variable names, followed by > '>' (such as in tests), were interpreted as html control codes. > I didn't really want to be putting control codes all over the place but I'll > endeavour to get this working! > > Regards, > Dan > > |-------------> > |(Embedded | > |image moved | > |to file: | > |pic12499.pcx)| > | | > |-------------> > >------------------------------------------------------------------------| > |"M. Adam Davis" <spamBeGoneadavis@spam@spam_OUTUBASICS.COM> | > |02/06/2000 13:45 | > >------------------------------------------------------------------------| > > Please respond to pic microcontroller discussion list <TakeThisOuTPICLISTspamMITVMA.MIT.EDU> > > To: PICLISTEraseMEMITVMA.MIT.EDU > cc: (bcc: Dan Lloyd/GBPTD/ABB) > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > Security Level:? Internal > > Just do > > /* <HTML><BODY><TITLE>This Darn C Program</TITLE><pre> > Program > Creator > Date > ... (no HTML code needed to format this area, it appears as > it is written in the browser, and is less cluttered for > the programmer to deal with) > ... > </pre><!- > */ > > void main(void) > { > ... > w=0xff; // ->This line needs a special comment in the docs<!- > } > > /* > This program does nothing, and is useless > Blah, blah blah</> > ... > </BODY></HTML> > */ > > Since there is no 'end' directive to tell the compiler to stop looking, you have > to put all the HTML in comments. > > Unfortunately, my mailer may get rid of the HTML tags before it is sent. If you > don't see anything usefull above, go to http://www.ubasics.com/adam/pic/doc/ and > look for cfile.htm. You'll need to add a new C language, as well. > > -Adam > > D Lloyd wrote: > > > > Hi, > > > > This is a *nice* idea - thanks. Fits in nicely with our philosophy of > > "intranet-ising" everything. > > I'll have a bash at this with some of our *.c files (asm? what's that? > <grin>); > > have to see if I can frig the compiler to ignore the html. > > > > Dan > > > > |-------------> > > |(Embedded | > > |image moved | > > |to file: | > > |pic20839.pcx)| > > | | > > |-------------> > > >------------------------------------------------------------------------| > > |"M. Adam Davis" <RemoveMEadavisEraseMEspam_OUTUBASICS.COM> | > > |01/06/2000 21:03 | > > >------------------------------------------------------------------------| > > > > Please respond to pic microcontroller discussion list <@spam@PICLISTRemoveMEEraseMEMITVMA.MIT.EDU> > > > > To: EraseMEPICLIST@spam@MITVMA.MIT.EDU > > cc: (bcc: Dan Lloyd/GBPTD/ABB) > > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > > > Security Level:? Internal > > > > Hmm... It appears as though my attachment didn't go through... > > > > Go to http://www.ubasics.com/adam/pic/doc to see the files > > asmfile.htm The html formatted assembly file > > TLMCHIP.INI The modified language suite file for mchip > > (use it to replace tlmchip.ini) > > MPASMhtm.MTC The modified MPASM.MTC file > > (use it in addition with mpasm.mtc) > > > > After copying the language files to your mplab directory, choose 'install > > language tools' from the project menu. Under the microchip lanuage tools, > there > > will ba an additional language, "MPASM(*.htm)". Select that, and put in the > > path to your mpasmwin.exe file. > > > > -Adam > > > > "M. Adam Davis" wrote: > > > > > > Along those lines, here is an assembly file marked up with enough HTML to > > > display properly in a browser... (Small attachment! Don't shoot me!) > > > > > > It is an htm file so that I can simply click on it and see the document. > > MPLAB > > > does care what extension a file has so I provided an extra language tool > file > > > and modified microchip's language tool suite file to accept htm files. > > > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified > TLMCHIP.INI). > > I > > > then installed my new language tool "MPASM(*.htm)" and now I can include htm > > > files as nodes in a project and assemble them under mplab. > > > > > > -Adam > > > > > > "Get the facts first, you can distort them later" - Mark Twain > > > > > > Mark Willis wrote: > > > > > > > > (Fixed the subject line, needed a colon after [OT].) > > > > > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > > > systems - the documentation was installed inside the source (.asm) > > > > files. > > > > > > > > IMO this is a good idea - This way the programmers could actually get at > > > > & see the docs, and were in fact in charge of the documentation's upkeep > > > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > > > nothing about the code, who writes the manual etc., months later, with > > > > no clue - And it ends up resembling the code's behavior SO little, that > > > > it's rather pathetic. > > > > > > > > They had a tool that'd extract the docs into a file that the > > > > documentation people were allowed to get at, then had a nice tool that > > > > re-formatted that text file into a properly formatted document. > > > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > > > "source code" file, and not include it directly into the code. And the > > > > extract document "compiled" (checked syntax) as a matter of course so > > > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > > > > > And of course you could verify that you didn't mess up the code when the > > > > docs were changed (compare the previous .obj files with current freshly > > > > compiled version, should be identical) - twas on a Z80/80186 dual > > > > processor machine. > > > > > > > > You already know about concepts like bug report filing, bug > > > > verification, change control boards, regression testing, and so on, I'll > > > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > > > I always feel my competence is being insulted, frankly. Now, "If we let > > > > management make decisions, it'll just encourage them", that definitely > > > > has truth to it, for some values of management <G>) Treat it like any > > > > other system, look for gaping holes, and design something that's able to > > > > cope with your organizations needs. > > > > > > > > Mark > > > > > > > > D Lloyd wrote: > > > > > Hi PICsters, > > > > > > > > > > As we all know that documentation of code is very important and that we > > all > > > > > *religiously* follow our procedures <cough, cough>, does anyone know of > > any good > > > > > templates regarding maintenance as opposed to development? > > > > > > > > > > Such templates would ideally relate to change control procedures, bug > > > > > maintenance etc. I went through the same exercise of obtaining such > > information > > > > > for development but procedures used by the likes of NASA are a bit > > overkill for > > > > > general embedded systems, so cut down information would be more > > beneficial. > > > > > > > > > > Any help/useful pointers would be appreciated. > > > > > > > > > > Kind Regards, > > > > > Dan Lloyd > > > > > > > > > > Firmware Engineer, Electronic Operations > > > > > ABB Metering. England. > > > > > > > > -- > > > > I re-ship for small US & overseas businesses, world-wide. > > > > (For private individuals at cost; ask.) > > > > > -------------------------------------------------------------------------------- > > Name: pic20839.pcx > > pic20839.pcx Type: PCX Image > (application/x-unknown-content-type-pcxfile) > > Encoding: base64 > > -------------------------------------------------------------------------------- > Name: pic12499.pcx > pic12499.pcx Type: application/x-unknown-content-type-pcxfile > Encoding: base64

part 0 12319 bytes content-type:application/octet-stream;Hi, It would seem not - not for Internet Explorer, anyway. This line of code: 'if((PhaseIdentifier >= PHASE_A_ID) && (PhaseIdentifier <= PHASE_C_ID))' causes the problem. It produces <Snip from Explorer> blah blah . ******************************************************************************** * Copyright 1999, ABB Metering Systems Limited, Stone, Staffordshire, England * *******************************************************************************/ /* = PHASE_A_ID)<+the remainder of code in the module (cannot show the code, for obvious reasons)> <Snip> There is a "/*</pre> |(Embedded | |image moved | |to file: | |pic03657.pcx)| | | |-------------> >------------------------------------------------------------------------| |"M. Adam Davis" <@spam@adavisspam_OUT.....UBASICS.COM> | |05/06/2000 20:09 | >------------------------------------------------------------------------| Please respond to pic microcontroller discussion list <spamBeGonePICLISTEraseMEMITVMA.MIT.EDU> To: PICLISTspamBeGoneMITVMA.MIT.EDU cc: (bcc: Dan Lloyd/GBPTD/ABB) Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures Security Level:? Internal hmm... As long as you don't have a '->' in the code, it shouldn't end the html comment tag '<!- ..... ->' -Adam D Lloyd wrote: > > Hi > > I did something along the lines of this but certain variable names, followed by {Quote hidden}> '>' (such as in tests), were interpreted as html control codes. > I didn't really want to be putting control codes all over the place but I'll > endeavour to get this working! > > Regards, > Dan > > |-------------> > |(Embedded | > |image moved | > |to file: | > |pic12499.pcx)| > | | > |-------------> > >------------------------------------------------------------------------| > |"M. Adam Davis" <RemoveMEadavis@spam@spamBeGoneUBASICS.COM> | > |02/06/2000 13:45 | > >------------------------------------------------------------------------| > > Please respond to pic microcontroller discussion list <.....PICLIST@spam@EraseMEMITVMA.MIT.EDU> > > To: .....PICLISTRemoveMEMITVMA.MIT.EDU > cc: (bcc: Dan Lloyd/GBPTD/ABB) > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > Security Level:? Internal > > Just do > > /* <HTML><BODY><TITLE>This Darn C Program</TITLE><pre> > Program > Creator > Date > ... (no HTML code needed to format this area, it appears as > it is written in the browser, and is less cluttered for > the programmer to deal with) > ... > </pre><!- > */ > > void main(void) > { > ... > w=0xff; // ->This line needs a special comment in the docs<!- > } > > /* > This program does nothing, and is useless > Blah, blah blah</> > ... > </BODY></HTML> > */ > > Since there is no 'end' directive to tell the compiler to stop looking, you have > to put all the HTML in comments. > > Unfortunately, my mailer may get rid of the HTML tags before it is sent. If you > don't see anything usefull above, go to http://www.ubasics.com/adam/pic/doc/ and {Quote hidden}> look for cfile.htm. You'll need to add a new C language, as well. > > -Adam > > D Lloyd wrote: > > > > Hi, > > > > This is a *nice* idea - thanks. Fits in nicely with our philosophy of > > "intranet-ising" everything. > > I'll have a bash at this with some of our *.c files (asm? what's that? > <grin>); > > have to see if I can frig the compiler to ignore the html. > > > > Dan > > > > |-------------> > > |(Embedded | > > |image moved | > > |to file: | > > |pic20839.pcx)| > > | | > > |-------------> > > >------------------------------------------------------------------------| > > |"M. Adam Davis" <.....adavisSTOPspam@spam@UBASICS.COM> | > > |01/06/2000 21:03 | > > >------------------------------------------------------------------------| > > > > Please respond to pic microcontroller discussion list <PICLISTEraseME@spam@MITVMA.MIT.EDU> {Quote hidden}> > > > To: RemoveMEPICLISTspamBeGoneMITVMA.MIT.EDU > > cc: (bcc: Dan Lloyd/GBPTD/ABB) > > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > > > Security Level:? Internal > > > > Hmm... It appears as though my attachment didn't go through... > > > > Go to http://www.ubasics.com/adam/pic/doc to see the files > > asmfile.htm The html formatted assembly file > > TLMCHIP.INI The modified language suite file for mchip > > (use it to replace tlmchip.ini) > > MPASMhtm.MTC The modified MPASM.MTC file > > (use it in addition with mpasm.mtc) > > > > After copying the language files to your mplab directory, choose 'install > > language tools' from the project menu. Under the microchip lanuage tools, > there > > will ba an additional language, "MPASM(*.htm)". Select that, and put in the > > path to your mpasmwin.exe file. > > > > -Adam > > > > "M. Adam Davis" wrote: > > > > > > Along those lines, here is an assembly file marked up with enough HTML to > > > display properly in a browser... (Small attachment! Don't shoot me!) > > > > > > It is an htm file so that I can simply click on it and see the document. > > MPLAB > > > does care what extension a file has so I provided an extra language tool > file > > > and modified microchip's language tool suite file to accept htm files. > > > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified > TLMCHIP.INI). > > I > > > then installed my new language tool "MPASM(*.htm)" and now I can include htm {Quote hidden}> > > files as nodes in a project and assemble them under mplab. > > > > > > -Adam > > > > > > "Get the facts first, you can distort them later" - Mark Twain > > > > > > Mark Willis wrote: > > > > > > > > (Fixed the subject line, needed a colon after [OT].) > > > > > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > > > systems - the documentation was installed inside the source (.asm) > > > > files. > > > > > > > > IMO this is a good idea - This way the programmers could actually get at > > > > & see the docs, and were in fact in charge of the documentation's upkeep > > > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > > > nothing about the code, who writes the manual etc., months later, with > > > > no clue - And it ends up resembling the code's behavior SO little, that > > > > it's rather pathetic. > > > > > > > > They had a tool that'd extract the docs into a file that the > > > > documentation people were allowed to get at, then had a nice tool that > > > > re-formatted that text file into a properly formatted document. > > > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > > > "source code" file, and not include it directly into the code. And the > > > > extract document "compiled" (checked syntax) as a matter of course so > > > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > > > > > And of course you could verify that you didn't mess up the code when the > > > > docs were changed (compare the previous .obj files with current freshly > > > > compiled version, should be identical) - twas on a Z80/80186 dual > > > > processor machine. > > > > > > > > You already know about concepts like bug report filing, bug > > > > verification, change control boards, regression testing, and so on, I'll > > > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > > > I always feel my competence is being insulted, frankly. Now, "If we let > > > > management make decisions, it'll just encourage them", that definitely > > > > has truth to it, for some values of management <G>) Treat it like any > > > > other system, look for gaping holes, and design something that's able to > > > > cope with your organizations needs. > > > > > > > > Mark > > > > > > > > D Lloyd wrote: > > > > > Hi PICsters, > > > > > > > > > > As we all know that documentation of code is very important and that we > > all > > > > > *religiously* follow our procedures <cough, cough>, does anyone know of {Quote hidden}> > any good > > > > > templates regarding maintenance as opposed to development? > > > > > > > > > > Such templates would ideally relate to change control procedures, bug > > > > > maintenance etc. I went through the same exercise of obtaining such > > information > > > > > for development but procedures used by the likes of NASA are a bit > > overkill for > > > > > general embedded systems, so cut down information would be more > > beneficial. > > > > > > > > > > Any help/useful pointers would be appreciated. > > > > > > > > > > Kind Regards, > > > > > Dan Lloyd > > > > > > > > > > Firmware Engineer, Electronic Operations > > > > > ABB Metering. England. > > > > > > > > -- > > > > I re-ship for small US & overseas businesses, world-wide. > > > > (For private individuals at cost; ask.) > > > > > -------------------------------------------------------------------------------- > > Name: pic20839.pcx > > pic20839.pcx Type: PCX Image > (application/x-unknown-content-type-pcxfile) > > Encoding: base64 > > -------------------------------------------------------------------------------- > Name: pic12499.pcx > pic12499.pcx Type: application/x-unknown-content-type-pcxfile > Encoding: base64 Content-type: application/octet-stream; name="pic03657.pcx" Content-Disposition: attachment; filename="pic03657.pcx" Attachment converted: creation:pic03657.pcx (????/----) (000161DC)

I've also tried moving text in and out of the body and html tags, and both IE and Netscape (4.72) print the entire file except for <!- ... -> tags. I did not know IE would let the '>' end a comment tag though... Just tested it. Netscape does the exact same thing. I'm in the process of looking it up in the HTML 4.01 spec (http://www.w3c.org/). I'll tell you what I come up with. It may end up that for C programs you woul dhave to use a program to filter it for you (ie, drop the file onto this program, and it creates a temporary file and opens the browser for it...) -Adam D Lloyd wrote: {Quote hidden}> > Hi, > > It would seem not - not for Internet Explorer, anyway. This line of code: > > 'if((PhaseIdentifier >= PHASE_A_ID) && (PhaseIdentifier <= PHASE_C_ID))' > > causes the problem. It produces > > <Snip from Explorer> > > blah blah > . > ******************************************************************************** > * Copyright 1999, ABB Metering Systems Limited, Stone, Staffordshire, England * > *******************************************************************************/ > /* > = PHASE_A_ID)<+the remainder of code in the module (cannot show the code, for > obvious reasons)> > > <Snip> > > There is a "/*</pre> > |(Embedded | > |image moved | > |to file: | > |pic03657.pcx)| > | | > |-------------> > >------------------------------------------------------------------------| > |"M. Adam Davis" <spamBeGoneadavisKILLspam@spam@UBASICS.COM> | > |05/06/2000 20:09 | > >------------------------------------------------------------------------| > > Please respond to pic microcontroller discussion list <PICLISTspam_OUT@spam@MITVMA.MIT.EDU> > > To: spamBeGonePICLIST@spam@MITVMA.MIT.EDU > cc: (bcc: Dan Lloyd/GBPTD/ABB) > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > Security Level:? Internal > > hmm... As long as you don't have a '->' in the code, it shouldn't end the html > comment tag '<!- ..... ->' > > -Adam > > D Lloyd wrote: > > > > Hi > > > > I did something along the lines of this but certain variable names, followed > by > > '>' (such as in tests), were interpreted as html control codes. > > I didn't really want to be putting control codes all over the place but I'll > > endeavour to get this working! > > > > Regards, > > Dan > > > > |-------------> > > |(Embedded | > > |image moved | > > |to file: | > > |pic12499.pcx)| > > | | > > |-------------> > > >------------------------------------------------------------------------| > > |"M. Adam Davis" <RemoveMEadavisEraseMEKILLspamUBASICS.COM> | > > |02/06/2000 13:45 | > > >------------------------------------------------------------------------| > > > > Please respond to pic microcontroller discussion list <spamBeGonePICLISTspam_OUTRemoveMEMITVMA.MIT.EDU> > > > > To: .....PICLISTRemoveMEMITVMA.MIT.EDU > > cc: (bcc: Dan Lloyd/GBPTD/ABB) > > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > > > Security Level:? Internal > > > > Just do > > > > /* <HTML><BODY><TITLE>This Darn C Program</TITLE><pre> > > Program > > Creator > > Date > > ... (no HTML code needed to format this area, it appears as > > it is written in the browser, and is less cluttered for > > the programmer to deal with) > > ... > > </pre><!- > > */ > > > > void main(void) > > { > > ... > > w=0xff; // ->This line needs a special comment in the docs<!- > > } > > > > /* > > This program does nothing, and is useless > > Blah, blah blah</> > > ... > > </BODY></HTML> > > */ > > > > Since there is no 'end' directive to tell the compiler to stop looking, you > have > > to put all the HTML in comments. > > > > Unfortunately, my mailer may get rid of the HTML tags before it is sent. If > you > > don't see anything usefull above, go to http://www.ubasics.com/adam/pic/doc/ > and > > look for cfile.htm. You'll need to add a new C language, as well. > > > > -Adam > > > > D Lloyd wrote: > > > > > > Hi, > > > > > > This is a *nice* idea - thanks. Fits in nicely with our philosophy of > > > "intranet-ising" everything. > > > I'll have a bash at this with some of our *.c files (asm? what's that? > > <grin>); > > > have to see if I can frig the compiler to ignore the html. > > > > > > Dan > > > > > > |-------------> > > > |(Embedded | > > > |image moved | > > > |to file: | > > > |pic20839.pcx)| > > > | | > > > |-------------> > > > >------------------------------------------------------------------------| > > > |"M. Adam Davis" <adavis@spam@UBASICS.COM> | > > > |01/06/2000 21:03 | > > > >------------------------------------------------------------------------| > > > > > > Please respond to pic microcontroller discussion list > <EraseMEPICLISTRemoveMESTOPspamMITVMA.MIT.EDU> > > > > > > To: RemoveMEPICLISTKILLspamTakeThisOuTMITVMA.MIT.EDU > > > cc: (bcc: Dan Lloyd/GBPTD/ABB) > > > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > > > > > Security Level:? Internal > > > > > > Hmm... It appears as though my attachment didn't go through... > > > > > > Go to http://www.ubasics.com/adam/pic/doc to see the files > > > asmfile.htm The html formatted assembly file > > > TLMCHIP.INI The modified language suite file for mchip > > > (use it to replace tlmchip.ini) > > > MPASMhtm.MTC The modified MPASM.MTC file > > > (use it in addition with mpasm.mtc) > > > > > > After copying the language files to your mplab directory, choose 'install > > > language tools' from the project menu. Under the microchip lanuage tools, > > there > > > will ba an additional language, "MPASM(*.htm)". Select that, and put in the > > > path to your mpasmwin.exe file. > > > > > > -Adam > > > > > > "M. Adam Davis" wrote: > > > > > > > > Along those lines, here is an assembly file marked up with enough HTML to > > > > display properly in a browser... (Small attachment! Don't shoot me!) > > > > > > > > It is an htm file so that I can simply click on it and see the document. > > > MPLAB > > > > does care what extension a file has so I provided an extra language tool > > file > > > > and modified microchip's language tool suite file to accept htm files. > > > > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified > > TLMCHIP.INI). > > > I > > > > then installed my new language tool "MPASM(*.htm)" and now I can include > htm > > > > files as nodes in a project and assemble them under mplab. > > > > > > > > -Adam > > > > > > > > "Get the facts first, you can distort them later" - Mark Twain > > > > > > > > Mark Willis wrote: > > > > > > > > > > (Fixed the subject line, needed a colon after [OT].) > > > > > > > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > > > > systems - the documentation was installed inside the source (.asm) > > > > > files. > > > > > > > > > > IMO this is a good idea - This way the programmers could actually get at > > > > > & see the docs, and were in fact in charge of the documentation's upkeep > > > > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > > > > nothing about the code, who writes the manual etc., months later, with > > > > > no clue - And it ends up resembling the code's behavior SO little, that > > > > > it's rather pathetic. > > > > > > > > > > They had a tool that'd extract the docs into a file that the > > > > > documentation people were allowed to get at, then had a nice tool that > > > > > re-formatted that text file into a properly formatted document. > > > > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > > > > "source code" file, and not include it directly into the code. And the > > > > > extract document "compiled" (checked syntax) as a matter of course so > > > > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > > > > > > > And of course you could verify that you didn't mess up the code when the > > > > > docs were changed (compare the previous .obj files with current freshly > > > > > compiled version, should be identical) - twas on a Z80/80186 dual > > > > > processor machine. > > > > > > > > > > You already know about concepts like bug report filing, bug > > > > > verification, change control boards, regression testing, and so on, I'll > > > > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > > > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > > > > I always feel my competence is being insulted, frankly. Now, "If we let > > > > > management make decisions, it'll just encourage them", that definitely > > > > > has truth to it, for some values of management <G>) Treat it like any > > > > > other system, look for gaping holes, and design something that's able to > > > > > cope with your organizations needs. > > > > > > > > > > Mark > > > > > > > > > > D Lloyd wrote: > > > > > > Hi PICsters, > > > > > > > > > > > > As we all know that documentation of code is very important and that > we > > > all > > > > > > *religiously* follow our procedures <cough, cough>, does anyone know > of > > > any good > > > > > > templates regarding maintenance as opposed to development? > > > > > > > > > > > > Such templates would ideally relate to change control procedures, bug > > > > > > maintenance etc. I went through the same exercise of obtaining such > > > information > > > > > > for development but procedures used by the likes of NASA are a bit > > > overkill for > > > > > > general embedded systems, so cut down information would be more > > > beneficial. > > > > > > > > > > > > Any help/useful pointers would be appreciated. > > > > > > > > > > > > Kind Regards, > > > > > > Dan Lloyd > > > > > > > > > > > > Firmware Engineer, Electronic Operations > > > > > > ABB Metering. England. > > > > > > > > > > -- > > > > > I re-ship for small US & overseas businesses, world-wide. > > > > > (For private individuals at cost; ask.) > > > > > > > > > -------------------------------------------------------------------------------- > > > Name: pic20839.pcx > > > pic20839.pcx Type: PCX Image > > (application/x-unknown-content-type-pcxfile) > > > Encoding: base64 > > > > > -------------------------------------------------------------------------------- > > Name: pic12499.pcx > > pic12499.pcx Type: application/x-unknown-content-type-pcxfile > > Encoding: base64 > > -------------------------------------------------------------------------------- > Name: pic03657.pcx > pic03657.pcx Type: application/x-unknown-content-type-pcxfile > Encoding: base64

Ok, the fault is mine. I suspected this was the case in the beginning, but since it worked, I didn't question it. Comments are '' and you can put ANYTHING in between the comments as long as you end with '-->' (two hyphens). The issue is this: The comment tag is defined as having two hyphens, without them it is no longer a comment tag. The fact the Netscape and IE end at any '>' after a comment means they did not find a 'real' end comment, and so they are doing their best to make up for the web designer's mistake (mine), and they end at any end tag character '>'. So, the file /*<HTML><BODY><PRE> THIS IS A MESSAGE in the header </PRE> This program is a test of placing HTML comments in ... </body></HTML> Produces the output: THIS IS A MESSAGE in the header This program is a test of placing HTML comments in ... Sorry I made that mistake, I hope I haven't caused you to lose too much time over it. Just make sure you start with two hyphens, end with two hyphens, and have no whitespace in the start and end tag strings. "" -Adam D Lloyd wrote: {Quote hidden}> > Hi, > > It would seem not - not for Internet Explorer, anyway. This line of code: > > 'if((PhaseIdentifier >= PHASE_A_ID) && (PhaseIdentifier <= PHASE_C_ID))' > > causes the problem. It produces > > <Snip from Explorer> > > blah blah > . > ******************************************************************************** > * Copyright 1999, ABB Metering Systems Limited, Stone, Staffordshire, England * > *******************************************************************************/ > /* > = PHASE_A_ID)<+the remainder of code in the module (cannot show the code, for > obvious reasons)> > > <Snip> > > There is a "/*</pre> > |(Embedded | > |image moved | > |to file: | > |pic03657.pcx)| > | | > |-------------> > >------------------------------------------------------------------------| > |"M. Adam Davis" <spamBeGoneadavis@spam@UBASICS.COM> | > |05/06/2000 20:09 | > >------------------------------------------------------------------------| > > Please respond to pic microcontroller discussion list <RemoveMEPICLISTspam_OUTMITVMA.MIT.EDU> > > To: PICLISTspamMITVMA.MIT.EDU > cc: (bcc: Dan Lloyd/GBPTD/ABB) > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > Security Level:? Internal > > hmm... As long as you don't have a '->' in the code, it shouldn't end the html > comment tag '<!- ..... ->' > > -Adam > > D Lloyd wrote: > > > > Hi > > > > I did something along the lines of this but certain variable names, followed > by > > '>' (such as in tests), were interpreted as html control codes. > > I didn't really want to be putting control codes all over the place but I'll > > endeavour to get this working! > > > > Regards, > > Dan > > > > |-------------> > > |(Embedded | > > |image moved | > > |to file: | > > |pic12499.pcx)| > > | | > > |-------------> > > >------------------------------------------------------------------------| > > |"M. Adam Davis" <spam_OUTadavisspam_OUTspam_OUTUBASICS.COM> | > > |02/06/2000 13:45 | > > >------------------------------------------------------------------------| > > > > Please respond to pic microcontroller discussion list <PICLISTspam_OUTMITVMA.MIT.EDU> > > > > To: RemoveMEPICLISTKILLspam@spam@MITVMA.MIT.EDU > > cc: (bcc: Dan Lloyd/GBPTD/ABB) > > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > > > Security Level:? Internal > > > > Just do > > > > /* <HTML><BODY><TITLE>This Darn C Program</TITLE><pre> > > Program > > Creator > > Date > > ... (no HTML code needed to format this area, it appears as > > it is written in the browser, and is less cluttered for > > the programmer to deal with) > > ... > > </pre><!- > > */ > > > > void main(void) > > { > > ... > > w=0xff; // ->This line needs a special comment in the docs<!- > > } > > > > /* > > This program does nothing, and is useless > > Blah, blah blah</> > > ... > > </BODY></HTML> > > */ > > > > Since there is no 'end' directive to tell the compiler to stop looking, you > have > > to put all the HTML in comments. > > > > Unfortunately, my mailer may get rid of the HTML tags before it is sent. If > you > > don't see anything usefull above, go to http://www.ubasics.com/adam/pic/doc/ > and > > look for cfile.htm. You'll need to add a new C language, as well. > > > > -Adam > > > > D Lloyd wrote: > > > > > > Hi, > > > > > > This is a *nice* idea - thanks. Fits in nicely with our philosophy of > > > "intranet-ising" everything. > > > I'll have a bash at this with some of our *.c files (asm? what's that? > > <grin>); > > > have to see if I can frig the compiler to ignore the html. > > > > > > Dan > > > > > > |-------------> > > > |(Embedded | > > > |image moved | > > > |to file: | > > > |pic20839.pcx)| > > > | | > > > |-------------> > > > >------------------------------------------------------------------------| > > > |"M. Adam Davis" <adavisspamBeGone.....UBASICS.COM> | > > > |01/06/2000 21:03 | > > > >------------------------------------------------------------------------| > > > > > > Please respond to pic microcontroller discussion list > <KILLspamPICLIST.....MITVMA.MIT.EDU> > > > > > > To: spam_OUTPICLISTKILLspamMITVMA.MIT.EDU > > > cc: (bcc: Dan Lloyd/GBPTD/ABB) > > > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > > > > > Security Level:? Internal > > > > > > Hmm... It appears as though my attachment didn't go through... > > > > > > Go to http://www.ubasics.com/adam/pic/doc to see the files > > > asmfile.htm The html formatted assembly file > > > TLMCHIP.INI The modified language suite file for mchip > > > (use it to replace tlmchip.ini) > > > MPASMhtm.MTC The modified MPASM.MTC file > > > (use it in addition with mpasm.mtc) > > > > > > After copying the language files to your mplab directory, choose 'install > > > language tools' from the project menu. Under the microchip lanuage tools, > > there > > > will ba an additional language, "MPASM(*.htm)". Select that, and put in the > > > path to your mpasmwin.exe file. > > > > > > -Adam > > > > > > "M. Adam Davis" wrote: > > > > > > > > Along those lines, here is an assembly file marked up with enough HTML to > > > > display properly in a browser... (Small attachment! Don't shoot me!) > > > > > > > > It is an htm file so that I can simply click on it and see the document. > > > MPLAB > > > > does care what extension a file has so I provided an extra language tool > > file > > > > and modified microchip's language tool suite file to accept htm files. > > > > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified > > TLMCHIP.INI). > > > I > > > > then installed my new language tool "MPASM(*.htm)" and now I can include > htm > > > > files as nodes in a project and assemble them under mplab. > > > > > > > > -Adam > > > > > > > > "Get the facts first, you can distort them later" - Mark Twain > > > > > > > > Mark Willis wrote: > > > > > > > > > > (Fixed the subject line, needed a colon after [OT].) > > > > > > > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > > > > systems - the documentation was installed inside the source (.asm) > > > > > files. > > > > > > > > > > IMO this is a good idea - This way the programmers could actually get at > > > > > & see the docs, and were in fact in charge of the documentation's upkeep > > > > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > > > > nothing about the code, who writes the manual etc., months later, with > > > > > no clue - And it ends up resembling the code's behavior SO little, that > > > > > it's rather pathetic. > > > > > > > > > > They had a tool that'd extract the docs into a file that the > > > > > documentation people were allowed to get at, then had a nice tool that > > > > > re-formatted that text file into a properly formatted document. > > > > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > > > > "source code" file, and not include it directly into the code. And the > > > > > extract document "compiled" (checked syntax) as a matter of course so > > > > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > > > > > > > And of course you could verify that you didn't mess up the code when the > > > > > docs were changed (compare the previous .obj files with current freshly > > > > > compiled version, should be identical) - twas on a Z80/80186 dual > > > > > processor machine. > > > > > > > > > > You already know about concepts like bug report filing, bug > > > > > verification, change control boards, regression testing, and so on, I'll > > > > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > > > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > > > > I always feel my competence is being insulted, frankly. Now, "If we let > > > > > management make decisions, it'll just encourage them", that definitely > > > > > has truth to it, for some values of management <G>) Treat it like any > > > > > other system, look for gaping holes, and design something that's able to > > > > > cope with your organizations needs. > > > > > > > > > > Mark > > > > > > > > > > D Lloyd wrote: > > > > > > Hi PICsters, > > > > > > > > > > > > As we all know that documentation of code is very important and that > we > > > all > > > > > > *religiously* follow our procedures <cough, cough>, does anyone know > of > > > any good > > > > > > templates regarding maintenance as opposed to development? > > > > > > > > > > > > Such templates would ideally relate to change control procedures, bug > > > > > > maintenance etc. I went through the same exercise of obtaining such > > > information > > > > > > for development but procedures used by the likes of NASA are a bit > > > overkill for > > > > > > general embedded systems, so cut down information would be more > > > beneficial. > > > > > > > > > > > > Any help/useful pointers would be appreciated. > > > > > > > > > > > > Kind Regards, > > > > > > Dan Lloyd > > > > > > > > > > > > Firmware Engineer, Electronic Operations > > > > > > ABB Metering. England. > > > > > > > > > > -- > > > > > I re-ship for small US & overseas businesses, world-wide. > > > > > (For private individuals at cost; ask.) > > > > > > > > > -------------------------------------------------------------------------------- > > > Name: pic20839.pcx > > > pic20839.pcx Type: PCX Image > > (application/x-unknown-content-type-pcxfile) > > > Encoding: base64 > > > > > -------------------------------------------------------------------------------- > > Name: pic12499.pcx > > pic12499.pcx Type: application/x-unknown-content-type-pcxfile > > Encoding: base64 > > -------------------------------------------------------------------------------- > Name: pic03657.pcx > pic03657.pcx Type: application/x-unknown-content-type-pcxfile > Encoding: base64

part 0 16253 bytes content-type:application/octet-stream;Hi, This works fine - thank you for your effort in sorting that out. I didnt waste much time because I have been banging my head against a wall with a comms problem all day....would you like to sort that out, too ? ; ) Just kidding. I was hoping to get around to fixing it tomorrow but this is good. Thank you again for your help and effort. Regards, Dan |-------------> |(Embedded | |image moved | |to file: | |pic22572.pcx)| | | |-------------> >------------------------------------------------------------------------| |"M. Adam Davis" <adavisspamUBASICS.COM> | |06/06/2000 14:48 | >------------------------------------------------------------------------| Please respond to pic microcontroller discussion list <RemoveMEPICLISTspamBeGoneRemoveMEMITVMA.MIT.EDU> To: KILLspamPICLISTspamBeGoneMITVMA.MIT.EDU cc: (bcc: Dan Lloyd/GBPTD/ABB) Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures Security Level:? Internal Ok, the fault is mine. I suspected this was the case in the beginning, but since it worked, I didn't question it. Comments are '' and you can put ANYTHING in between the comments as long as you end with '-->' (two hyphens). The issue is this: The comment tag is defined as having two hyphens, without them it is no longer a comment tag. The fact the Netscape and IE end at any '>' after a comment means they did not find a 'real' end comment, and so they are doing their best to make up for the web designer's mistake (mine), and they end at any end tag character '>'. So, the file /*<HTML><BODY><PRE> THIS IS A MESSAGE in the header </PRE> This program is a test of placing HTML comments in ... </body></HTML> Produces the output: THIS IS A MESSAGE in the header This program is a test of placing HTML comments in ... Sorry I made that mistake, I hope I haven't caused you to lose too much time over it. Just make sure you start with two hyphens, end with two hyphens, and have no whitespace in the start and end tag strings. "" -Adam D Lloyd wrote: {Quote hidden}> > Hi, > > It would seem not - not for Internet Explorer, anyway. This line of code: > > 'if((PhaseIdentifier >= PHASE_A_ID) && (PhaseIdentifier <= PHASE_C_ID))' > > causes the problem. It produces > > <Snip from Explorer> > > blah blah > . > ******************************************************************************** > * Copyright 1999, ABB Metering Systems Limited, Stone, Staffordshire, England * > *******************************************************************************/ > /* > = PHASE_A_ID)<+the remainder of code in the module (cannot show the code, for > obvious reasons)> > > <Snip> > > There is a "/*</pre> > |(Embedded | > |image moved | > |to file: | > |pic03657.pcx)| > | | > |-------------> > >------------------------------------------------------------------------| > |"M. Adam Davis" <@spam@adavisSTOPspam@spam@UBASICS.COM> | > |05/06/2000 20:09 | > >------------------------------------------------------------------------| > > Please respond to pic microcontroller discussion list <PICLISTspamBeGonespamBeGoneMITVMA.MIT.EDU> > > To: spamBeGonePICLISTMITVMA.MIT.EDU > cc: (bcc: Dan Lloyd/GBPTD/ABB) > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > Security Level:? Internal > > hmm... As long as you don't have a '->' in the code, it shouldn't end the html {Quote hidden}> comment tag '<!- ..... ->' > > -Adam > > D Lloyd wrote: > > > > Hi > > > > I did something along the lines of this but certain variable names, followed > by > > '>' (such as in tests), were interpreted as html control codes. > > I didn't really want to be putting control codes all over the place but I'll > > endeavour to get this working! > > > > Regards, > > Dan > > > > |-------------> > > |(Embedded | > > |image moved | > > |to file: | > > |pic12499.pcx)| > > | | > > |-------------> > > >------------------------------------------------------------------------| > > |"M. Adam Davis" <spam_OUTadavisSTOPspamUBASICS.COM> | > > |02/06/2000 13:45 | > > >------------------------------------------------------------------------| > > > > Please respond to pic microcontroller discussion list <RemoveMEPICLISTspamMITVMA.MIT.EDU> {Quote hidden}> > > > To: TakeThisOuTPICLISTspamRemoveMEMITVMA.MIT.EDU > > cc: (bcc: Dan Lloyd/GBPTD/ABB) > > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > > > Security Level:? Internal > > > > Just do > > > > /* <HTML><BODY><TITLE>This Darn C Program</TITLE><pre> > > Program > > Creator > > Date > > ... (no HTML code needed to format this area, it appears as > > it is written in the browser, and is less cluttered for > > the programmer to deal with) > > ... > > </pre><!- > > */ > > > > void main(void) > > { > > ... > > w=0xff; // ->This line needs a special comment in the docs<!- > > } > > > > /* > > This program does nothing, and is useless > > Blah, blah blah</> > > ... > > </BODY></HTML> > > */ > > > > Since there is no 'end' directive to tell the compiler to stop looking, you > have > > to put all the HTML in comments. > > > > Unfortunately, my mailer may get rid of the HTML tags before it is sent. If > you > > don't see anything usefull above, go to http://www.ubasics.com/adam/pic/doc/ > and > > look for cfile.htm. You'll need to add a new C language, as well. > > > > -Adam > > > > D Lloyd wrote: > > > > > > Hi, > > > > > > This is a *nice* idea - thanks. Fits in nicely with our philosophy of > > > "intranet-ising" everything. > > > I'll have a bash at this with some of our *.c files (asm? what's that? > > <grin>); > > > have to see if I can frig the compiler to ignore the html. > > > > > > Dan > > > > > > |-------------> > > > |(Embedded | > > > |image moved | > > > |to file: | > > > |pic20839.pcx)| > > > | | > > > |-------------> > > > >------------------------------------------------------------------------| > > > |"M. Adam Davis" <KILLspamadavisspamspam_OUTUBASICS.COM> | > > > |01/06/2000 21:03 | > > > >------------------------------------------------------------------------| > > > > > > Please respond to pic microcontroller discussion list > <PICLISTRemoveMEMITVMA.MIT.EDU> > > > > > > To: EraseMEPICLISTSTOPspamRemoveMEMITVMA.MIT.EDU > > > cc: (bcc: Dan Lloyd/GBPTD/ABB) > > > Subject: Re: [OT]: - Firmware Maintenance Templates/Procedures > > > > > > Security Level:? Internal > > > > > > Hmm... It appears as though my attachment didn't go through... > > > > > > Go to http://www.ubasics.com/adam/pic/doc to see the files > > > asmfile.htm The html formatted assembly file > > > TLMCHIP.INI The modified language suite file for mchip > > > (use it to replace tlmchip.ini) > > > MPASMhtm.MTC The modified MPASM.MTC file > > > (use it in addition with mpasm.mtc) > > > > > > After copying the language files to your mplab directory, choose 'install > > > language tools' from the project menu. Under the microchip lanuage tools, > > there > > > will ba an additional language, "MPASM(*.htm)". Select that, and put in the > > > path to your mpasmwin.exe file. > > > > > > -Adam > > > > > > "M. Adam Davis" wrote: > > > > > > > > Along those lines, here is an assembly file marked up with enough HTML to {Quote hidden}> > > > display properly in a browser... (Small attachment! Don't shoot me!) > > > > > > > > It is an htm file so that I can simply click on it and see the document. > > > MPLAB > > > > does care what extension a file has so I provided an extra language tool > > file > > > > and modified microchip's language tool suite file to accept htm files. > > > > (mpasm.mtc --> mpasmhtm.mtc with some modification and modified > > TLMCHIP.INI). > > > I > > > > then installed my new language tool "MPASM(*.htm)" and now I can include > htm > > > > files as nodes in a project and assemble them under mplab. > > > > > > > > -Adam > > > > > > > > "Get the facts first, you can distort them later" - Mark Twain > > > > > > > > Mark Willis wrote: > > > > > > > > > > (Fixed the subject line, needed a colon after [OT].) > > > > > > > > > > One thing I've seen that I mostly liked, in past, was in aviation safety > > > > > systems - the documentation was installed inside the source (.asm) > > > > > files. > > > > > > > > > > IMO this is a good idea - This way the programmers could actually get at > > > > > & see the docs, and were in fact in charge of the documentation's upkeep > > > > > and maintenance (gasp!) - SO often, it's marketing or someone who knows > > > > > nothing about the code, who writes the manual etc., months later, with > > > > > no clue - And it ends up resembling the code's behavior SO little, that > > > > > it's rather pathetic. > > > > > > > > > > They had a tool that'd extract the docs into a file that the > > > > > documentation people were allowed to get at, then had a nice tool that > > > > > re-formatted that text file into a properly formatted document. > > > > > Nowadays, HTML comes to mind <G> Probably could treat it as a separate > > > > > "source code" file, and not include it directly into the code. And the > > > > > extract document "compiled" (checked syntax) as a matter of course so > > > > > you couldn't "oops" without noticing, well, not too badly anyways. > > > > > > > > > > And of course you could verify that you didn't mess up the code when the > > > > > docs were changed (compare the previous .obj files with current freshly > > > > > compiled version, should be identical) - twas on a Z80/80186 dual > > > > > processor machine. > > > > > > > > > > You already know about concepts like bug report filing, bug > > > > > verification, change control boards, regression testing, and so on, I'll > > > > > assume, if you've seen what NASA has to offer. (IMO some co's go way > > > > > overboard on paranoia on "If we fix a bug it'll just make 15 new bugs.", > > > > > I always feel my competence is being insulted, frankly. Now, "If we let > > > > > management make decisions, it'll just encourage them", that definitely > > > > > has truth to it, for some values of management <G>) Treat it like any > > > > > other system, look for gaping holes, and design something that's able to {Quote hidden}> > > > > cope with your organizations needs. > > > > > > > > > > Mark > > > > > > > > > > D Lloyd wrote: > > > > > > Hi PICsters, > > > > > > > > > > > > As we all know that documentation of code is very important and that > we > > > all > > > > > > *religiously* follow our procedures <cough, cough>, does anyone know > of > > > any good > > > > > > templates regarding maintenance as opposed to development? > > > > > > > > > > > > Such templates would ideally relate to change control procedures, bug {Quote hidden}> > > > > > maintenance etc. I went through the same exercise of obtaining such > > > information > > > > > > for development but procedures used by the likes of NASA are a bit > > > overkill for > > > > > > general embedded systems, so cut down information would be more > > > beneficial. > > > > > > > > > > > > Any help/useful pointers would be appreciated. > > > > > > > > > > > > Kind Regards, > > > > > > Dan Lloyd > > > > > > > > > > > > Firmware Engineer, Electronic Operations > > > > > > ABB Metering. England. > > > > > > > > > > -- > > > > > I re-ship for small US & overseas businesses, world-wide. > > > > > (For private individuals at cost; ask.) > > > > > > > > > -------------------------------------------------------------------------------- > > > Name: pic20839.pcx > > > pic20839.pcx Type: PCX Image > > (application/x-unknown-content-type-pcxfile) > > > Encoding: base64 > > > > > -------------------------------------------------------------------------------- > > Name: pic12499.pcx > > pic12499.pcx Type: application/x-unknown-content-type-pcxfile > > Encoding: base64 > > -------------------------------------------------------------------------------- > Name: pic03657.pcx > pic03657.pcx Type: application/x-unknown-content-type-pcxfile > Encoding: base64 Content-type: application/octet-stream; name="pic22572.pcx" Content-Disposition: attachment; filename="pic22572.pcx" Attachment converted: creation:pic22572.pcx (????/----) (00016206)