flat assembler
Message board for the users of flat assembler.

Index > Main > Current documentation completeness? (FASM.PDF)

Goto page Previous  1, 2
Author
Thread Post new topic Reply to topic
typedef



Joined: 25 Jul 2010
Posts: 2913
Location: 0x77760000
typedef
shutdownall wrote:
typedef wrote:
shutdownall wrote:
to improve documentation.
Rolling Eyes


What do you mean by improve?

Is it not good as it is ? I don't get it......

What else do you want to know about it ? Shocked Shocked Shocked

How to compile ?


Okay lets say better extend as improve. What I mean is internal documentation as this is a open source project and internal structures would make life easier to adapt new functions to FASM like different instruction sets. I spend lot of time to understand tables.inc, preproce.inc, x86_64.inc and how datastructures in the table file has to be interpreted and internally processed. Wink


Hahahaha....

You are talking about back end source files. lol

So you wanted him(Tomasz) to document all the source files ? Read the comments in the source files.

Well, if for once you understand how all the pre-processing and structuring works then why don't "improve" the documentation with the knowledge that you have gained ? Wink
Post 15 Jan 2012, 01:29
View user's profile Send private message Reply with quote
l_inc



Joined: 23 Oct 2009
Posts: 881
l_inc
rohagymeg
I don't know, why local inhabitants gave a such on my opinion aggressive response, but you're right. Fasm's official documentation still lacks many things, that you only can find within this board. E.g., fasm's standard macro if supports also generation of signed comparison with the keyword signed, but you won't find this feature anywhere in the documentation. Besides, fasm's preprocessor since version 1.69 supports calculations based on the rept-directive (very important and very useful feature in some cases), and the most official documentation of this feature is this forum's post which is not even sticky. There are also some minor properties, that you can only find out empirically rather than reading the official documentation.
Post 18 Jan 2012, 16:11
View user's profile Send private message Reply with quote
revolution
When all else fails, read the source


Joined: 24 Aug 2004
Posts: 17284
Location: In your JS exploiting you and your system
revolution
l_inc: You are welcome to help out and submit a proposed change to the fasm text.
Post 18 Jan 2012, 17:31
View user's profile Send private message Visit poster's website Reply with quote
shutdownall



Joined: 02 Apr 2010
Posts: 518
Location: Munich
shutdownall
typedef wrote:

So you wanted him(Tomasz) to document all the source files ? Read the comments in the source files.


What comments you are talking about ? The non-existing ? Rolling Eyes
The only kind of help is the name of labels and variables.
But this will not provide information about structures used internally.
Yes you can step through the code and with the time you learn about it but this is really a time spending process.

typedef wrote:

Well, if for once you understand how all the pre-processing and structuring works then why don't "improve" the documentation with the knowledge that you have gained ? Wink


I will do soon. Wink
Post 18 Jan 2012, 17:58
View user's profile Send private message Send e-mail Reply with quote
l_inc



Joined: 23 Oct 2009
Posts: 881
l_inc
revolution
1. Is the latex source of the documentation (it seems to be created with latex) available for public access?

2. I believe to know at least one reason, why the preprocessor computation capability is still not documented. The reason seems to be a little inconsistency in numbers processing mentioned here. I suppose, the author may have some adjustment plans regarding the extended capabilities of the rept directive.

3. Unfortunately my student's life does not allow me to abandon my current study-related time consuming projects I'm engaged in. That's not a problem to add one more item to the hundreds others in my FIFO todo-list, but it's not a matter of observable time to accomplish it.
With my last post I was just answering the original topic question rather than reproaching someone for documentation lacks.
Post 18 Jan 2012, 19:41
View user's profile Send private message Reply with quote
GhostXoPCorp



Joined: 13 Dec 2008
Posts: 199
Location: 01F0:0100
GhostXoPCorp
Quote:
That's not a problem to add one more item to the hundreds others in my FIFO todo-list


Thats alot of compilers, you guys tag team in their forums?


Quote:
Unfortunately my student's life does not allow me to abandon my current study-related time consuming projects


Bullshit. You just posted on the forum. Wink

Add what you believe is needed, surely any help offered is more then appreciated in my opinion. Don't like what we have now? Go fix it! Maybe your opinion on what it should be is better then what it is now, and if it is, good job and thanks a bunch, we will all be happy you did Smile

..but if we don't like it you will know.

_________________
Oh that divide overflow. Just jumps out of the bushes every time to scare the day lights out of me.
Post 21 Jan 2012, 08:33
View user's profile Send private message Reply with quote
forge



Joined: 18 Feb 2012
Posts: 1
forge
Without making any comment about the completeness of the documentation,
I will say that it is somewhat scattered, and that the threads on the forum
especially regarding the macro instructions, add some clarity to the manual.

Has anyone considered adding a wiki? (yes, i searched Wink)

Thanks!
Post 18 Feb 2012, 09:15
View user's profile Send private message Reply with quote
adroit



Joined: 21 Feb 2010
Posts: 252
adroit
I agree. There is lack of documentation on FASM internally, but I honestly can't blame Tomasz for this, because documenting such a complex software is difficult to maintain, much less there are at least three documentation: source code documentation, programmer's manual, assembler internals, (and if necessary, user manual). As forge suggested, a wiki, imho, would do just find. Everyone can contribute since we are so eager to have internal doc, as am I Very Happy
Post 25 Feb 2012, 02:17
View user's profile Send private message Reply with quote
l_inc



Joined: 23 Oct 2009
Posts: 881
l_inc
I support the wiki idea. That should not be too hard. IMHO it should be started by a trusted member like Tomasz Grysztar or revolution or [you name him/her] by means of partial copy-pasting (with restructuring) the existing data from the trusted sources like the pdf from the fasm package, these pages and even this post. Then I would also probably add a couple of articles and useful macro samples. Rolling Eyes
Post 25 Feb 2012, 23:40
View user's profile Send private message Reply with quote
idle



Joined: 06 Jan 2011
Posts: 359
Location: Ukraine
idle
Do you need a more structured FAQ with Wiki?
Where the info come from: this/those forums etc sources - i suppose.
You are just too lazy to use search button or google.
No serious but true.
Post 26 Feb 2012, 06:24
View user's profile Send private message Reply with quote
Tomasz Grysztar



Joined: 16 Jun 2003
Posts: 7725
Location: Kraków, Poland
Tomasz Grysztar
The wiki is not a new idea. But it needs someone to give it the necessary initial intertia.
Post 26 Feb 2012, 11:51
View user's profile Send private message Visit poster's website Reply with quote
bubach



Joined: 17 Sep 2004
Posts: 340
Location: Trollhättan, Sweden
bubach
I suggest using
http://www.pmwiki.org/

With maybe some of these skins:
http://www.pmwiki.org/wiki/Cookbook/EvolverSkin
http://www.pmwiki.org/wiki/Cookbook/GraynessSkin
http://www.pmwiki.org/wiki/Cookbook/MarathonSkin

+ Customizations to fit the fasm main page and forum in color and such. I could even host a "try" on asmhackers.net

Only problem with a diffrent hosting is that you can't use something to connect the log in from the forum, like this:
http://www.pmwiki.org/wiki/Cookbook/AuthPhpbb2Sso
Post 27 Feb 2012, 00:22
View user's profile Send private message Reply with quote
Display posts from previous:
Post new topic Reply to topic

Jump to:  
Goto page Previous  1, 2

< Last Thread | Next Thread >
Forum Rules:
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You cannot attach files in this forum
You can download files in this forum


Copyright © 1999-2020, Tomasz Grysztar. Also on YouTube, Twitter.

Website powered by rwasa.