sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

apps/nshlib/nsh_parse.c: Add some comments.

Browse Source 
Add some comments to nsh_parse.c emphasizing the reason that things are done in the order that they are.  Perhaps such comments will avoid similar breakage in the future.
This commit is contained in:
Gregory Nutt 2020-05-17 19:01:23 -06:00 committed by Xiang Xiao
parent 60428baed6
commit 4f54a75c48
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
nshlib/nsh_parse.c
View File

@ -489,6 +489,24 @@ static int nsh_execute(FAR struct nsh_vtbl_s *vtbl,
#endif
int ret;
/* DO NOT CHANGE THE ORDERING OF THE FOLLOWING STEPS
*
* They must work as follows:
*
* 1. Load a file from file system if possible. An external command on a
* file system with the provided name (and on the defined PATH) takes
* precendence over any other source of a command by that name. This
* allows the user to replace a built-in command with a command on a`
* file system
*
* 2. If not, run a built-in application of that name if possible. A
* built-in application will take precendence over any NSH command.
*
* 3. If not, run an NSH command line command if possible.
*
* 4. If not, report that the command was not found.
*/
/* Does this command correspond to an application filename?
* nsh_fileapp() returns:
*
@ -539,7 +557,7 @@ static int nsh_execute(FAR struct nsh_vtbl_s *vtbl,
* indicates that the application task was spawned
* successfully but returned failure exit status.
*
* Note the priority if not effected by nice-ness.
* Note the priority is not effected by nice-ness.
*/
#ifdef CONFIG_NSH_BUILTIN_APPS