Skip to content

Commit

Permalink
docs/developers.txt, docs/nut.dict: document some caveats about using…
Browse files Browse the repository at this point in the history
… IDEs to develop NUT

Signed-off-by: Jim Klimov <[email protected]>
  • Loading branch information
jimklimov committed Apr 7, 2024
1 parent 96de317 commit 8827ddf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/developers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,15 @@ Some supporting maintenance and development is doable with IntelliJ IDEA,
making some things easier to do than with a simple Notepad, but it does
not handle C/C++ development as such.

Take note that some IDEs can store their project data in the source root
directory of a project (such as NUT codebase). While `.gitignore` rules
can take care of not adding your local configuration into the SCM, these
locations can be wiped by a careless `git clean -fdX`. You are advised
to explore configuring your IDE to store project configurations outside
the source codebase location, or to track such directories as `nbproject`
or `nb-cache` as a separate Git repository (not necessarily a submodule
of NUT nor really diligently tracked) to avoid such surprises.

IDE notes on Windows
~~~~~~~~~~~~~~~~~~~~

Expand Down
4 changes: 3 additions & 1 deletion docs/nut.dict
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
personal_ws-1.1 en 3484 utf-8
personal_ws-1.1 en 3486 utf-8
AAC
AAS
ABI
Expand Down Expand Up @@ -2067,6 +2067,7 @@ fc
fcb
fcntl
fd
fdX
fds
fe
featureReport
Expand Down Expand Up @@ -2599,6 +2600,7 @@ nanosleep
nashkaminski
natively
nb
nbproject
nbr
nbsp
nd
Expand Down

0 comments on commit 8827ddf

Please sign in to comment.