Skip to content

Commit a8175f1

Browse files
authored
Merge pull request #1359 from prachi237/Kbase
Improved knowledge Base
2 parents 2ceb725 + 4b4dfa5 commit a8175f1

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

src/maintainer/knowledge_base.rst

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Particularities on Windows
8888
==========================
8989

9090
This document presents conda-forge and conda-build information and examples
91-
when building on Windows.
91+
while building on Windows.
9292

9393

9494
Local testing
@@ -98,9 +98,9 @@ The first thing that you should know is that you can locally test Windows
9898
builds of your packages even if you don’t own a Windows machine. Microsoft
9999
makes available free, official Windows virtual machines (VMs) `at this website
100100
<https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/>`_. If you
101-
are unfamiliar with VM systems or have trouble installing Microsoft’s, please
102-
use a general web search to investigate — while these topics are beyond the
103-
scope of this documentation, there is ample discussion of them on the broader
101+
are unfamiliar with VM systems or have trouble installing Microsoft’s VMs, please
102+
use a general web search to explore — while these topics are beyond the
103+
scope of this documentation, there are ample discussions on them on the broader
104104
Internet.
105105

106106
In order to compile native code (C, C++, etc.) on Windows, you will need to
@@ -116,17 +116,15 @@ versions are:
116116
While you can obtain these tools by installing the right version of the full
117117
`Visual Studio <https://visualstudio.microsoft.com/>`_ development
118118
environment, you can save a lot of time and bandwidth by installing standalone
119-
“build tools” packages. The links are:
119+
“build tools” packages. The links are as follows:
120120

121121
* For Python 2.7: `Microsoft Visual C++ Compiler for Python 2.7
122122
<https://www.microsoft.com/download/details.aspx?id=44266>`_.
123123
* For Python 3.5–3.7: `Microsoft Build Tools for Visual Studio 2017
124124
<https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2017>`_.
125125

126-
Please see `the Python wiki page on Windows compilers
127-
<https://wiki.python.org/moin/WindowsCompilers>`_ if you need more
128-
information.
129-
126+
If you need more information. Please refer `the Python wiki page on Windows compilers
127+
<https://wiki.python.org/moin/WindowsCompilers>`.
130128

131129
Simple CMake-Based ``bld.bat``
132130
------------------------------
@@ -163,7 +161,7 @@ build for such projects.
163161
The following feedstocks are examples of this build structure deployed:
164162

165163
* `libpng <https://github.com/conda-forge/libpng-feedstock/blob/master/recipe/bld.bat>`_
166-
* `pugixml <https://github.com/conda-forge/pugixml-feedstock/blob/master/recipe/bld.bat>`_
164+
* `Pugixml <https://github.com/conda-forge/pugixml-feedstock/blob/master/recipe/bld.bat>`_
167165

168166

169167
Building for different VC versions
@@ -206,9 +204,9 @@ Compilers are dependencies with a special syntax and are always added to ``requi
206204

207205
There are currently three supported compilers:
208206

209-
- c
207+
- C
210208
- cxx
211-
- fortran
209+
- Fortran
212210

213211
A package that needs all three compilers would define
214212

@@ -223,7 +221,7 @@ A package that needs all three compilers would define
223221
.. note::
224222

225223
Appropriate compiler runtime packages will be automatically added to the package's runtime requirements and therefore
226-
there's no need to specify ``libgcc`` or ``libgfortran``. There is additional information about how conda-build 3 treats
224+
there's no need to specify ``libgcc`` or ``libgfortran``. There are additional informations about how conda-build 3 treats
227225
compilers in the `conda docs <https://docs.conda.io/projects/conda-build/en/latest/source/compiler-tools.html>`_.
228226

229227
.. _cdt_packages:
@@ -232,10 +230,13 @@ Core Dependency Tree Packages (CDTs)
232230
------------------------------------
233231

234232
Dependencies outside of the ``conda-forge`` channel should be avoided (see :ref:`no_external_deps`).
235-
However, there are a few exceptions: some dependencies are so close to the system
236-
that they are not packaged with ``conda-forge``. These dependencies have to be satisfied with
237-
*Core Dependency Tree* (CDT) packages. A CDT package consists of repackaged CentOS binaries from the
238-
appropriate version, either 6 or 7 depending on user choice and platform. We manage the build of CDT
233+
However, there are a few exceptions:
234+
235+
Some dependencies are so close to the system that they are not packaged with ``conda-forge``.
236+
These dependencies have to be satisfied with *Core Dependency Tree* (CDT) packages.
237+
238+
A CDT package consists of repackaged CentOS binaries from the appropriate version,
239+
either 6 or 7 depending on user choice and platform. We manage the build of CDT
239240
packages using a centralized repo, `conda-forge/cdt-builds <https://github.com/conda-forge/cdt-builds>`_,
240241
as opposed to generating feedstocks for them. (Note that historically we did use feedstocks but this
241242
practice has been deprecated.) To add a new CDT, make a PR on the

0 commit comments

Comments
 (0)