From 1035ed30ecd7e07e6d6d6858bc3016414d650282 Mon Sep 17 00:00:00 2001 From: Sergei Vorobev Date: Thu, 30 Jun 2016 18:41:55 -0700 Subject: [PATCH] Move Modules related notes from internals.md into src/Modules/README.md --- docs/building/internals.md | 11 ----------- src/Modules/README.md | 25 +++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 11 deletions(-) create mode 100644 src/Modules/README.md diff --git a/docs/building/internals.md b/docs/building/internals.md index ca22828a8b..f9bc607295 100644 --- a/docs/building/internals.md +++ b/docs/building/internals.md @@ -32,14 +32,3 @@ it should be listed as a dependency for FullCLR $Top folder (src\Microsoft.Power * If assembly is part of CoreCLR build, it should be listed as a dependency for CoreCLR $Top folder (src\powershell) - - -Modules ----------- - -There are 3 modules directories with the same purpose: they have **content** files (i.e. `*.psm1`, `*.psd1`) -which would be binplaced by `dotnet` - -- `src\Modules` shared between all flavours -- `src\Microsoft.PowerShell.ConsoleHost\Modules` FullCLR (Windows) -- `src\powershell\Modules` CoreCLR (all platforms) diff --git a/src/Modules/README.md b/src/Modules/README.md new file mode 100644 index 0000000000..d651071fb5 --- /dev/null +++ b/src/Modules/README.md @@ -0,0 +1,25 @@ +Modules +========== + +There are 3 directories with **content** files. +Content files includes: + +- ps1xml +- psm1 +- psd1 +- ps1 + +These files are copyied as-is by `dotnet` + +- **Shared** is shared between all flavours +- **Full** for FullCLR (Windows) +- **Core** for CoreCLR (all platforms) + +Notes +----------- + +* We have files with the same names in "Full" and "Core" folders. +That means that the contents of these two files are different. +I.e. if it's .psd1 file, it could be because `CmdletsToExport` are different for different platforms. + +* Also, we should never have files with the same names under "Full" and "Shared" (or "Core" and "Shared").