.WEND to be replaced by .ENDW

[Vortex]

Reading the example section of the page entitled .WHILE and .ENDW (IA32, AMD64) in the help file :

Code: [Select]

.WHILE EAX != 8
    nop
.WEND
.WEND should be replaced by .ENDW :

Code: [Select]

.WHILE EAX != 8
    nop
.ENDW

[John Z]

Hi Vortex,

Good catch.  I've found several typo type errors as well in the past. Nothing big but similar, where perhaps the entry was not fully updated as in this case.  Well that and a typo or two here and there....

If the forum finds enough of them, and I'm not sure how many that is, the help file is something that, if we need to or want to, can be maintained.

Maybe the Help file needs its own thread to collect changes?

John Z

[HellOfMice]

When an error like this one is found it would be a good idea to have a place where to find the last updated version of the different files
Sometimes I read the help file, lastly it was this morning about PARMAREA but I never have seen this one because I don't like macros.
In PARMAREA the help file does not indicate the maximum value. Today I tested with 20 because a very big use of sprintf.

[Vortex]

Hello Philippe,

The help file is mentioning about PARMAREA.

In the page :

PROC and ENDP directives (IA32, AMD64)

The optional PARMAREA = expression specifies the size of the parameter area. It must be specified if the procedure is calling other procedures, and must be the size of the largest parameter area passed to any procedure. It can be larger (will just waste space), but it may not be smaller. The expression must be a constant expression.

Hello John,

Maybe the Help file needs its own thread to collect changes?

That's possible. In the BCX forum ( BCX Basic Forum ) , there are threads announcing the updates in the documentation.

[HellOfMice]

Hi Vortex,


I read this this morning and said it was possible to have more than 16.
I had 16 in my mind after reading one your last macros


Thank you

[Vortex]

Hello Philippe,

I think you are referring to this thread :

https://forum.pellesc.de/index.php?topic=11157.0

My apologies if my statements were misleading, I added this line :

EDIT : PARMAREA does not impose a limit of 16 parameters.

[HellOfMice]

Thank you Vortex

[John Z]

I have successfully rebuilt the Pelles C help file.  Needs a few tweaks but it all works
and looks the same and the .While - .ENDW fix is included.

I didn't get the right start page, and the title is from an old project of mine, see attached image.
So some minor tweaks needed for the build, however it is all there and everything works.

Unfortunately though it is over 1Meg which is the current posting limit, at least for now, for regular users. 
Christian for sure, or maybe a Moderator too, can post larger files (see Downloads )

If it becomes worthwhile to add information, or make a number of fixes, going forward it can be done by the forum.

John Z

Update: Fixed - intro and title now correct....

[HellOfMice]

Thank you John.


Now if someone could include it in the setup file.


 

[Vortex]

The help file could be enriched with more samples. I could contribute.

[John Z]

Pelle C also supports adding external help files to the Help Menu.

Under 'Tools - Customize - Help Files'  so help files full of examples can be done without impacting the original Pelles C Help file.  Could be an ASM Example help file, a C examples help file, etc.

John Z

Found one thing wrong with the recreated help file - the help context sensitive links appear broken. 
This means clicking on highlighted C keyword and pressing F1 does not work.  This feature usually involves a common .h file between the make help and the poide source.  I'll see if possible to fix but not optimistic....

[Marco]

I think it would also be worth adding a new topic/help file about confirmed known bugs. This would be of assistance to developers during code debugging. For example: https://forum.pellesc.de/index.php?topic=10896.msg37732#msg37732

[TimoVJL]

Add-In for help system for checking source file type might help to direct to better help file ?

[John Z]

Hi TimoVJL,

That makes sense too.

I think a starting point might be to get a Child Board, or Top Level for collecting inputs for existing or new help files.
Maybe an errata Child Board specifically for Pelles standard Help file corrections. 
Or keep under Bugs Section and recommend the help file 'bug' have titles include 'Help File' to separate out.
 
Then another something for an Examples Help file inputs?

Best if the Moderators figure out some agreed forum structure if all think it is worth doing.

John Z