Changeset e2ea8d7e in mainline for uspace/app/bdsh/cmds/builtins/README

Timestamp:

2008-08-27T05:36:12Z (16 years ago)

Author:

Tim Post <echo@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

1b4b7b6

Parents:

b510d52

Message:

Housekeeping list, complete lingering things before they get forgotten:

• cli_*() now sets a global cli_errno, error functions cleaned up
• Finish internal cli_*() functions in util.c
• Don't expose cli_init() or cli_finit()
• Get rid of unused globals
• Don't set globals in commands themselves
• Update README files
• Fix stale comments

File:

• uspace/app/bdsh/cmds/builtins/README (modified) (1 diff)

uspace/app/bdsh/cmds/builtins/README

@@ -5 +5 @@
 Examples of what should be a built-in and not a module would be:
 
-cd     (the cwd needs to be updated)
-prompt (the prompt needs to be updated)
-enable (the euid needs to be updated)
+cd     (cliuser_t->cwd needs to be updated)
+
+In the future, more user preferences will be set via built-in commands,
+such as the formatting of the prompt string (HelenOS doesn't yet have
+an environment, much less PS*, even if it did we'd likely do it a little
+differently).
 
 .... etc.
 
-Anything that does _not_ need to write to this structure should be included
-as a module, not a built in.
+Anything that does _not_ need to use this structure should be included
+as a module, not a built in. If you want to include a new command, there
+is a 99% chance that you want it to be a module.
 
-For now, a skeleton directory of stuff that will exist lives here.
+
+