Developer Tools

This chapter describes the development ecosystem generally used to create new modules.

• Working with git as a user
  • ns-3’s Git workflow in a nutshell
  • Setup of a personal repository
  • Add the official ns-3 repository as remote upstream
  • Add your forked repository as remote
  • Keep in sync your repository with latest ns-3-dev updates
  • Start a new branch to do some work
  • Edit and commit the modifications
  • Rebase your branch on top of master
  • Pushing your changes to origin
  • Submit work for review
  • Porting patches from mercurial repositories to git
• Working with git as a maintainer
  • Pushing your own work
  • Review and merge someone else’s work
  • Making a release
• Working with CMake
  • Configuring the project
  • Manually refresh the CMake cache
  • Building the project
  • Adding a new module
  • Migrating a Waf module to CMake
  • Running programs
  • Modifying files
  • CCache and Precompiled Headers
• Logging
  • Overview
  • How to add logging to your code
  • Controlling timestamp precision
• Tests
  • Overview
  • Background
  • Testing framework
  • How to write tests
• Creating a new ns-3 model
  • Design Approach
  • Scaffolding
  • Initial Implementation
  • Adding a Sample Script
  • Add a Subclass
  • Build Core Functions and Unit Tests
• Adding a New Module to ns-3
  • Step 0 - Module Layout
  • Step 1 - Create a Module Skeleton
  • Step 3 - Declare Source Files
  • Step 4 - Declare Public Header Files
  • Step 5 - Declare Tests
  • Step 6 - Declare Examples
  • Step 7 - Examples Run as Tests
  • Step 8 - Configure and Build
  • Step 9 - Python Bindings
• Creating Documentation
  • Documenting with Sphinx
  • Documenting with Doxygen
• Profiling
  • Memory Profilers
  • Performance Profilers
  • System calls profilers
  • Compilation Profilers
  • CMake Profiler
• Working with gitlab-ci-local
• Windows 10
  • Windows 10 package prerequisites
  • Windows 10 Docker container
  • Windows 10 Vagrant