Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-13408

Investigate ideal directory structure for modularisation

    • Type: Icon: Task Task
    • Resolution: Done
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Not Applicable
    • None
    • Storage Engines
    • StorEng - Defined Pipeline

      Description

      This ticket is a result of (1), (2), and (3) comments from the modularisation doc.

      Conduct an investigation into whether we should transition to a module-specific directory structure, containing test, docs, src, and include directories.

      src/
       |── Module/
         |── Module.h           # (WT-13407)
         |── *.c
         |── test/              # module specific (unit) tests  (WT-13410)
         |── docs/ or README.md # module specific documentation (WT-13413)
         |── CMake

      This investigation will consider the trade-offs of such a change against our current structure and evaluate the feasibility of implementing this.

      Current structure

      |── src/
        |── CMake
        |── Module
        |── Include
      |── docs/
      |── test/

      Scope 

      • Analysis of the current directory structure and its limitations.
      • Benefits and drawbacks of transitioning to a structure where each module has its own test, docs, src, include.
      • Consider the trade-offs of such a change against our current structure and evaluate the feasibility of implementing this within the current project timeline
      • Explore an Ideal modular dir structure.
      • Provide a recommendation and next steps.

       

            Assignee:
            backlog-server-storage-engines [DO NOT USE] Backlog - Storage Engines Team
            Reporter:
            siddhartha.mahajan@mongodb.com Sid Mahajan
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: