Documentation: migrate pages from wiki

[raiden00pl]

Not all pages below are suitable for migration, some pages are outdated, some are already migrated. Everything listed here for better tracking of the issue.

It's better to have all valuable information in one place (Documentation). Then we can use grep to find all the useful information about a given subject.

Getting Started with NuttX https://cwiki.apache.org/confluence/display/NUTTX/Getting+Started+with+NuttX

• nothing to migrate

Graphics https://cwiki.apache.org/confluence/display/NUTTX/Graphics

• https://cwiki.apache.org/confluence/display/NUTTX/Framebuffer+Character+Driver
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629474
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139630154
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629473
• https://cwiki.apache.org/confluence/display/NUTTX/CNxConsole+Keyboard+Input
• https://cwiki.apache.org/confluence/display/NUTTX/NxWM+Threading
• https://cwiki.apache.org/confluence/display/NUTTX/Wide+Font+Support
• https://cwiki.apache.org/confluence/display/NUTTX/NxTerm+Example

NuttX How-To's https://cwiki.apache.org/confluence/display/NUTTX/NuttX+How-To%27s

• https://cwiki.apache.org/confluence/display/NUTTX/Analyzing+Cortex-M+Hardfaults
• https://cwiki.apache.org/confluence/display/NUTTX/ARMv7-M+Run+Time+Stack+Checking
• https://cwiki.apache.org/confluence/display/NUTTX/Auto-Mounter
• https://cwiki.apache.org/confluence/display/NUTTX/Changing+the+System+Clock+Configuration
• https://cwiki.apache.org/confluence/display/NUTTX/Converting+Legacy+Configurations+to+Use+kconfig-mconf[]
  • obsolote
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629444
• https://cwiki.apache.org/confluence/display/NUTTX/Disabling+the+Stack+Dump+During+Debugging
• https://cwiki.apache.org/confluence/display/NUTTX/Including+Files+in+board.h
• https://cwiki.apache.org/confluence/display/NUTTX/Integrating+with+Newlib
• https://cwiki.apache.org/confluence/display/NUTTX/IPv6
• https://cwiki.apache.org/confluence/display/NUTTX/Kernel+Threads+with+Custom+Stacks
• https://cwiki.apache.org/confluence/display/NUTTX/Logging+to+a+RAM+Buffer
• https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Protected+Build
• https://cwiki.apache.org/confluence/display/NUTTX/Platform+Directories
• https://cwiki.apache.org/confluence/display/NUTTX/Porting+Drivers+to+the+STM32+F7
• https://cwiki.apache.org/confluence/display/NUTTX/Semihosting
• https://cwiki.apache.org/confluence/display/NUTTX/Signaling+Events+from+Interrupt+Handlers
• https://cwiki.apache.org/confluence/display/NUTTX/Signaling+Semaphores+and+Priority+Inheritance
• https://cwiki.apache.org/confluence/display/NUTTX/Smaller+Vector+Tables
• https://cwiki.apache.org/confluence/display/NUTTX/STM32+CCM+Allocator
• https://cwiki.apache.org/confluence/display/NUTTX/STM32+Null+Pointer+Detection
• https://cwiki.apache.org/confluence/display/NUTTX/Using+Kernel+Threads
• https://cwiki.apache.org/confluence/display/NUTTX/Versioning+and+Task+Names
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629466

Networking https://cwiki.apache.org/confluence/display/NUTTX/Networking

• https://cwiki.apache.org/confluence/display/NUTTX/CONFIG_NET_GUARDSIZE
• https://cwiki.apache.org/confluence/display/NUTTX/Delayed+ACK+and+TCP+Performance
• https://cwiki.apache.org/confluence/display/NUTTX/Network+Link+Management
  • nothing to migrate
• https://cwiki.apache.org/confluence/display/NUTTX/SLIP+Configuration
• https://cwiki.apache.org/confluence/display/NUTTX/TCP+Network+Performance
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629530
• https://cwiki.apache.org/confluence/display/NUTTX/Work+Queue+Deadlocks

Application/NSH How-To's https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629534

• https://cwiki.apache.org/confluence/display/NUTTX/Updating+a+Release+System+with+ELF+Programs
• https://cwiki.apache.org/confluence/display/NUTTX/APPNAME+vs.+PROGNAME
  • obsolote, APPNAME removed
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629538
• https://cwiki.apache.org/confluence/display/NUTTX/Building+NuttX+with+Applications+Outside+of+the+Source+Tree
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629550
• https://cwiki.apache.org/confluence/display/NUTTX/Custom+Application+Directories
• https://cwiki.apache.org/confluence/display/NUTTX/Debugging+ELF+Loadable+Modules
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629545
• https://cwiki.apache.org/confluence/display/NUTTX/Multiple+NSH+Sessions
• https://cwiki.apache.org/confluence/display/NUTTX/NSH+Network+Link+Management
• https://cwiki.apache.org/confluence/display/NUTTX/RAM+Disks+and+ROM+Disks
• https://cwiki.apache.org/confluence/display/NUTTX/Reading+CAN+Messages
• https://cwiki.apache.org/confluence/display/NUTTX/Removing+Device+Drivers+with+NSH
• https://cwiki.apache.org/confluence/display/NUTTX/Running+Applications+from+NSH

NuttX Implementation/Design https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629479

• https://cwiki.apache.org/confluence/display/NUTTX/ARMv7-M+Hardfaults%2C+SVCALL%2C+and+Debuggers
• https://cwiki.apache.org/confluence/display/NUTTX/Asynchronous+vs.+Synchronous+Context+Switches
• https://cwiki.apache.org/confluence/display/NUTTX/Bottom-Half+Interrupt+Handlers
• https://cwiki.apache.org/confluence/display/NUTTX/Cancellation+Points
• https://cwiki.apache.org/confluence/display/NUTTX/chip.h+FAQ
• https://cwiki.apache.org/confluence/display/NUTTX/Critical+Section+Monitor
• https://cwiki.apache.org/confluence/display/NUTTX/Debug+Output+%28SYSLOG%29+Issues
• https://cwiki.apache.org/confluence/display/NUTTX/Detaching+File+Descriptors
• https://cwiki.apache.org/confluence/display/NUTTX/Device+Drivers+vs.+Bus+Drivers+and+GPIO+Drivers
• https://cwiki.apache.org/confluence/display/NUTTX/Device+Nodes
• https://cwiki.apache.org/confluence/display/NUTTX/Driver+Types
• https://cwiki.apache.org/confluence/display/NUTTX/Dynamic+Clocking
• https://cwiki.apache.org/confluence/display/NUTTX/Effects+of+Disabling+Interrupts+or+Pre-Emption+on+Response+Latency
• https://cwiki.apache.org/confluence/display/NUTTX/ENOTTY+ioctl%28%29+Return+Value
• https://cwiki.apache.org/confluence/display/NUTTX/High+Performance%2C+Zero+Latency+Interrupts
• https://cwiki.apache.org/confluence/display/NUTTX/Kernel+Modules+vs+Shared+Libaries
• https://cwiki.apache.org/confluence/display/NUTTX/Linux+Processes+vs+NuttX+Tasks
• https://cwiki.apache.org/confluence/display/NUTTX/Memory+Configurations
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629488
• https://cwiki.apache.org/confluence/display/NUTTX/Naming+of+Architecture%2C+MCU%2C+and+Board+Interfaces
• https://cwiki.apache.org/confluence/display/NUTTX/Naming+of+OS+Internal+Functions
• https://cwiki.apache.org/confluence/display/NUTTX/Nested+Interrupts
• https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Initialization+Sequence
• https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Simulation
• https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Tasking
• https://cwiki.apache.org/confluence/display/NUTTX/Oneshot+Timers+and+CPU+Load+Measurement
• https://cwiki.apache.org/confluence/display/NUTTX/Per-Thread+Interrupt+Controls
• https://cwiki.apache.org/confluence/display/NUTTX/Short+Time+Delays
• https://cwiki.apache.org/confluence/display/NUTTX/Signal+Handler+Tour
• https://cwiki.apache.org/confluence/display/NUTTX/SMP
• https://cwiki.apache.org/confluence/display/NUTTX/SMP+Critical+Sections
• https://cwiki.apache.org/confluence/display/NUTTX/SYSLOG
• https://cwiki.apache.org/confluence/display/NUTTX/Task+Exit+Sequence
• https://cwiki.apache.org/confluence/display/NUTTX/Tasks+vs.+Threads+FAQ
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=152115079
• https://cwiki.apache.org/confluence/display/NUTTX/Tickless+OS
• https://cwiki.apache.org/confluence/display/NUTTX/Upper+Half+and+Lower+Half+Drivers
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=158862687

Platforms https://cwiki.apache.org/confluence/display/NUTTX/Platforms

• nothing to migrate

Virtual File System https://cwiki.apache.org/confluence/display/NUTTX/Virtual+File+System

• https://cwiki.apache.org/confluence/display/NUTTX/How+NXFFS+Works
• https://cwiki.apache.org/confluence/display/NUTTX/NuttX+File+System
• https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139630111
• https://cwiki.apache.org/confluence/display/NUTTX/Pseudo+File+System
• https://cwiki.apache.org/confluence/display/NUTTX/SmartFS+Internals
• https://cwiki.apache.org/confluence/display/NUTTX/Special+Files+and+Device+Numbers
• https://cwiki.apache.org/confluence/display/NUTTX/Using+SmartFS

[lvanasse]

@raiden00pl would it still be useful to work on the documentation even if it is outdated? I understand that there's not a lot of reason to work on getting outdated documentation in the current documentation format, but I'm thinking it might be difficult to see what is outdated or not. Also, you might need setups to validate how outdated are the pages.

What are your thoughts?

[raiden00pl]

Unless the doc page is completely outdated, porting it still has value, and outdated content can be fixed later.
We can mark such pages with .. warning:: note at the top until they are fixed.

As you mentioned, it can be difficult to determine what is outdated and what isn't, especially for people who haven't been following all the PRs in NuttX over the last few years.

So I'm not sure how we should proceed. Maybe we can just hope that during the PR review process, we'll be able to catch any outdated content and fix it immediately or mark the page as outdated.

[lvanasse]

I was thinking that maybe we should still port everything and as people consult the documentation and try them we'll know if they are outdated.

But I like your idea of adding a warning at the beginning. I'll try to work on some of those pages that are left. Thank you :).

[lvanasse]

@raiden00pl This page: https://cwiki.apache.org/confluence/display/NUTTX/STM32+Null+Pointer+Detection was already migrated :). #14231 Noticed just too late 😅

[lvanasse]

@raiden00pl darn again, very sorry, just notice: https://cwiki.apache.org/confluence/display/NUTTX/STM32+CCM+Allocator also was already migrated 😅

[lvanasse]

@raiden00pl here are 3 other pages to check (once they are merged) :)

#14240 - Kernel Threads with Custom Stacks
#14239 - Versioning and Task Names
#14236 - Using Kernel Threads

Cheers!

[lvanasse]

@raiden00pl here are 3 other pages to check (once they are merged) :)

#14274 :

• Disabling the Stack Dump During Debugging
• Including files in board.
• Why can't I put my special stuff in NuttX header files? (https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629466)

Cheers!

[lvanasse]

@raiden00pl here are 4 other pages to check (once they are merged) :)

#14417 :

• NuttX Protected Build
• Integrating with Newlib
• IPv6
• Logging to a RAM buffer

Cheers!

[lvanasse]

@raiden00pl here are 3 other pages to check (once they are merged) :)

#14419 :

• Semihosting
• Porting drivers to stm32f7
• Platform directories

Cheers!

PS. I'll try to finish the NuttX How-To's section this week :)

[raiden00pl]

great ! thanks for your help :)