github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
fd9c3e5ebb
azure-sdk-for-cpp/sdk/storage
History
Ahson Khan fd9c3e5ebb
Fix true spelling errors across all source and header files within the SDK and add exceptions for false positives. (#2209) 
Part of https://github.com/Azure/azure-sdk-for-cpp/issues/1277, checking what types of warnings the CI emits.

Verified all SDK product `.cpp`, `.hpp`, `.txt`, and `.md` files, primarily focused on azure-core. They are all clean now. There are some exceptions that needs to be added for keyvault and storage, but they are false positives, so not a concern.

> `cspell lint --config .vscode/cspell.json *.hpp */**/*.hpp`

CSpell: Files checked: 188, Issues found: 0 in 0 files

> `cspell lint --config .vscode/cspell.json *.cpp */**/*.cpp`

CSpell: Files checked: 186, Issues found: 88 in 15 files (keyvault and storage false positives, or tests)

> `cspell lint --config .vscode/cspell.json *.md */**/*.md`

CSpell: Files checked: 45, Issues found: 5 in 2 files (eng/common)

> `cspell lint --config .vscode/cspell.json *.txt */**/*.txt`

CSpell: Files checked: 44, Issues found: 0 in 0 files

> `cspell lint --config .vscode/cspell.json *.* */**/*`

CSpell: Files checked: 646, Issues found: 328 in 69 files (most of these are in eng\docs\api\assets\style.css or eng/common)

Deprioritize and ignored the errors from the test files (including test resource json files), and `eng/common` since those need to be centrally fixed.
2021-05-07 21:04:58 +00:00
..
azure-storage-blobs Fix true spelling errors across all source and header files within the SDK and add exceptions for false positives. (#2209) 2021-05-07 21:04:58 +00:00
azure-storage-common Fix true spelling errors across all source and header files within the SDK and add exceptions for false positives. (#2209) 2021-05-07 21:04:58 +00:00
azure-storage-files-datalake Fix true spelling errors across all source and header files within the SDK and add exceptions for false positives. (#2209) 2021-05-07 21:04:58 +00:00
azure-storage-files-shares Fix true spelling errors across all source and header files within the SDK and add exceptions for false positives. (#2209) 2021-05-07 21:04:58 +00:00
ci.yml Move Azure::MatchConditions and Azure::ModifiedConditions (#1810) 2021-03-09 01:45:22 +00:00
CMakeLists.txt Rename and structure unit test and perf tests (#1706) 2021-02-23 05:55:12 +00:00
README.md Moving json to internal (#1378) 2021-01-22 11:12:27 -08:00
test-resources-post.ps1 Live test framework (#608) 2020-11-05 14:59:05 -08:00
test-resources.json Supported file tier and removed unwanted functions. (#1529) 2021-02-01 13:22:06 +08:00

README.md

Azure Storage Client Library for C++

The Azure Storage Client Library for C++ allows you to build applications against Microsoft Azure Storage. For an overview of Azure Storage, see Introduction to Microsoft Azure Storage.

Features

  • Blobs
    • Create/Delete/List Containers
    • Create/Read/Update/Delete/List Blobs
  • DataLake Gen 2
    • Create/Delete File Systems
    • Create/Delete Directories
    • Create/Read/Append/Flush/Delete Files
  • File Shares
    • Create/Delete Shares
    • Create/Delete Directories
    • Create/Read/Delete Files

Getting started

For the best development experience, we recommend that developers use the CMake projects in Visual Studio to view and build the source code together with its dependencies.

Requirements

To call Azure services, you must first have an Azure subscription. Sign up for a free trial or use your MSDN subscriber benefits.

Need Help?

Be sure to check out the Azure Storage Forum on MSDN if you need help, or use StackOverflow.

Collaborate & Contribute

We gladly accept community contributions.

For general suggestions about Azure, use our Azure feedback forum.

Download & Install

Install Dependencies

Windows

On Windows, dependencies are managed by vcpkg. You can reference the Quick Start to quickly set yourself up. After Vcpkg is initialized and bootstrapped, you can install the dependencies:

vcpkg.exe install libxml2:x64-windows-static curl:x64-windows-static

Unix Platforms

You can use the package manager on different Unix platforms to install the dependencies. The dependencies to be installed are:

  • CMake 3.13.0 or higher.
  • libxml2.
  • OpenSSL.
  • libcurl.

Build from Source

First, download the repository to your local folder:

git clone https://github.com/Azure/azure-sdk-for-cpp.git

Windows

Use CMake to generate the solution file

In a new folder you created under the root directory:

cmake .. -A x64 -DCMAKE_TOOLCHAIN_FILE=<YOUR_VCPKG_INSTALL_DIR>/scripts/buildsystems/vcpkg.cmake
cmake --build .

The built library will be in .\sdk\<ProjectDir>\<Configuration>\ respectively for Azure Core and Azure Storage. e.g. azure_core.lib will be in .\sdk\core\azure-core\Debug for debug configuration.

Use Visual Studio's Open by folder feature

Open the root folder of the library with Visual Studio's Open folder feature.

If Vcpkg is not globally integrated, then you need to open CMakeSettings.json and change the Make toolchain file to be <YOUR_VCPKG_INSTALL_DIR>/scripts/buildsystems/vcpkg.cmake and save. Then you can build Azure Storage libraries by selecting the target in Visual Studio, or simply build all. The libraries will be in <ProjectRoot>\out\build\<Configuration>\sdk\<LibraryName> respectively.

Unix Platforms

You can run the following command in a new folder created under the downloaded code's root folder to build the code.

cmake .. -DCMAKE_BUILD_TYPE=Debug
cmake --build .

Then you can consume the built library with the header files. make/ninja install is work in progress.

Via NuGet

WIP TODO when ready.

Via Vcpkg

WIP TODO when ready.

Dependencies

Code Samples

To get started with the coding, please visit the following code samples: