Re: Basic Documentation Update
On 12/31/20 7:36 AM, Nathan Hartman wrote: ASCII art could be a good fit for the many README.txt files we have. Even if it doesn't go in a README.txt, if it's a good diagram then in the interest of making the information available to everyone, I think it should be added in documentation first and then the format can always be changed and made more fancy later. Besides, there's something nostalgic about ASCII-art. :-) Cheers, Nathan I use ASCII art all the time in my documentation for ASIC chip design. I even wrote some vim scripts to help me draw the ASCIi art. Plus I have a tool I wrote to convert ASCII Art files to PNG / SVG output format. It has a lot of provisions for EE block diagrams and symbols (AND / OR gates, transistors, etc.) and so I called it ASCEE. Ken
Re: Basic Documentation Update
Thanks for the response I attach the map now. Any question or criticism welcome I know nothing about mermaid or SVG but I can process the map with aalib if requested ;) Nathan is correct of course. My focus is on novice's experience. The Wiki information is the most visible and the more accurate, clear and extensive it is, the better for anyone like me who wants to get involved in developing and using NuttX TIA Grr El jue, 31 dic 2020 a las 9:37, Nathan Hartman () escribió: > On Thu, Dec 31, 2020 at 10:03 AM Maciej Wójcik wrote: > > > > Hello, > > > > I would suggest making merge request to the documentation inside > > repository. Confluence document could be copied there and then ascii art > > added. > > > > But it is my personal opinion. Not sure what was decided about confluence > > wiki. Yet, I had an impression that documentation should be gradually > moved > > to the repository. > > Yes, I agree. I think documentation should be in the repository rather > than Confluence because anyone can open a pull request for the > repository. We're more limited with Confluence. > > > Regarding ascii art itself, why not make a normal diagram. I think there > is > > simple graphing syntax available called mermaid or you could attach svg. > > ASCII art could be a good fit for the many README.txt files we have. > > Even if it doesn't go in a README.txt, if it's a good diagram then in > the interest of making the information available to everyone, I think > it should be added in documentation first and then the format can > always be changed and made more fancy later. > > Besides, there's something nostalgic about ASCII-art. :-) > > Cheers, > Nathan > __start()-stm32_start.c | +stm32_boardinitialize()-stm32_boot.c:BOARD_DEPENDANT || |+stm32_spidev_initialize()-stm32_spi.c:ONLY CHIP SELECTS |+stm32_usbinitialize()- |+stm32_netinitialize()- |+board_autoled_initialize()- | nx_start()-nx_start.c | +net_initialize()-net_initialize.c || |+net_lockinitialize() |+mld_initialize() |+can_initialize() |+netlink_initialize() |+tcp_initialize() |+udp_initialize() |+usrsock_initialize() | +up_initialize()-arm_initialize.c || |+arm_dmainitialize() |+Config basic /dev nodes |+arm_serialinit() |+Console Init |+Crypto Config |+arm_netinitialize() ||| ||+stm32_spibus_initialize() || || |+arm_usbinitialize() |+L2 Cache Init | +board_early_initialize() +g_nx_initstate = OSINIT_HARDWARE +shm_initialize() +lib_initialize() +binfmt_initialize() +Start SMP +syslog_initialize() +g_nx_initstate = OSINIT_OSREADY +DEBUGVERIFY(nx_bringup()) || |+nx_create_initthread | | | +nx_start_task() | | | +nx_start_application() | | | +board_late_initialize()-stm32_boot.c:BOARD_DEPENDANT || |+stm32_bringup() +-kmm_givesemaphore() | +-up_idle() +stm32_i2ctool() +board_bmp180_initialize() +stm32_sdio_initialize() +stm32_usbhost_initialize() +stm32_pwm_setup() +stm32_can_setup() +stm32_mcp2515initialize() +
Re: Basic Documentation Update
On Thu, Dec 31, 2020 at 10:03 AM Maciej Wójcik wrote: > > Hello, > > I would suggest making merge request to the documentation inside > repository. Confluence document could be copied there and then ascii art > added. > > But it is my personal opinion. Not sure what was decided about confluence > wiki. Yet, I had an impression that documentation should be gradually moved > to the repository. Yes, I agree. I think documentation should be in the repository rather than Confluence because anyone can open a pull request for the repository. We're more limited with Confluence. > Regarding ascii art itself, why not make a normal diagram. I think there is > simple graphing syntax available called mermaid or you could attach svg. ASCII art could be a good fit for the many README.txt files we have. Even if it doesn't go in a README.txt, if it's a good diagram then in the interest of making the information available to everyone, I think it should be added in documentation first and then the format can always be changed and made more fancy later. Besides, there's something nostalgic about ASCII-art. :-) Cheers, Nathan
Re: Basic Documentation Update
Hello, I would suggest making merge request to the documentation inside repository. Confluence document could be copied there and then ascii art added. But it is my personal opinion. Not sure what was decided about confluence wiki. Yet, I had an impression that documentation should be gradually moved to the repository. Regarding ascii art itself, why not make a normal diagram. I think there is simple graphing syntax available called mermaid or you could attach svg. -- Maciej On Thu, 31 Dec 2020, 15:48 Grr, wrote: > Hello to all. > > I'm new into NuttX development and I made an ASCII-art function map of > NuttX initialization to hep update and improve > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Initialization+Sequence > and I'd like to know of Brennan Ashton thinks it can be incorporated into > his document > > My map is based on startup for stm32f4discovery board and doesn't have > _all_ the functions but covers pretty much all the most important to give a > very good idea of initialization in a graphic manner > > I'd also like to know what's the best practice to update text of the > aforementioned document since there are some parts to be updated according > to this up-to-date map > > I read somewhere I cannot attach file here so please tell me how to share > it > > Thanks in advance >
Re: Basic Documentation Update
On Thu, Dec 31, 2020 at 9:48 AM Grr wrote: > Hello to all. > > I'm new into NuttX development and I made an ASCII-art function map of > NuttX initialization to hep update and improve > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Initialization+Sequence > and I'd like to know of Brennan Ashton thinks it can be incorporated into > his document > > My map is based on startup for stm32f4discovery board and doesn't have > _all_ the functions but covers pretty much all the most important to give a > very good idea of initialization in a graphic manner > > I'd also like to know what's the best practice to update text of the > aforementioned document since there are some parts to be updated according > to this up-to-date map > > I read somewhere I cannot attach file here so please tell me how to share > it > > Thanks in advance > Hi! Thanks for writing. You should be able to attach files with a .txt extension. (The mailing list won't accept things like image files etc.) Please try to send the attachment with .txt Thanks again! Nathan
Basic Documentation Update
Hello to all. I'm new into NuttX development and I made an ASCII-art function map of NuttX initialization to hep update and improve https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Initialization+Sequence and I'd like to know of Brennan Ashton thinks it can be incorporated into his document My map is based on startup for stm32f4discovery board and doesn't have _all_ the functions but covers pretty much all the most important to give a very good idea of initialization in a graphic manner I'd also like to know what's the best practice to update text of the aforementioned document since there are some parts to be updated according to this up-to-date map I read somewhere I cannot attach file here so please tell me how to share it Thanks in advance
