Re: [edk2-devel] [edk2-redfish-client][PATCH] Initial edk2 redfish client repository

["Michael D Kinney" <michael.d.kinney@intel.com>]

Acked-by: Michael D Kinney <michael.d.kinney@intel.com>

> -----Original Message-----
> From: Chang, Abner <Abner.Chang@amd.com>
> Sent: Thursday, April 20, 2023 10:38 PM
> To: devel@edk2.groups.io; nicklew@nvidia.com; Kinney, Michael D <michael.d.kinney@intel.com>
> Cc: Igor Kulchytskyy <igork@ami.com>
> Subject: RE: [edk2-devel] [edk2-redfish-client][PATCH] Initial edk2 redfish client repository
> 
> [AMD Official Use Only - General]
> 
> Reviewed-by: Abner Chang <abner.chang@amd.com>
> 
> I have no feedbacks to this patch as we had reviewed this off line. However I would like to see @Michael D Kinney's comment on
> it.
> 
> Thanks
> Abner
> 
> > -----Original Message-----
> > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Nickle
> > Wang via groups.io
> > Sent: Friday, April 21, 2023 11:26 AM
> > To: devel@edk2.groups.io
> > Cc: Chang, Abner <Abner.Chang@amd.com>; Igor Kulchytskyy
> > <igork@ami.com>; Michael D Kinney <michael.d.kinney@intel.com>
> > Subject: [edk2-devel] [edk2-redfish-client][PATCH] Initial edk2 redfish client
> > repository
> >
> > Caution: This message originated from an External Source. Use proper
> > caution when opening attachments, clicking links, or responding.
> >
> >
> > Add required files to initial edk2 redfish client repository.
> >
> > Signed-off-by: Nickle Wang <nicklew@nvidia.com>
> > Cc: Abner Chang <abner.chang@amd.com>
> > Cc: Igor Kulchytskyy <igork@ami.com>
> > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > ---
> >  .gitignore      |  6 +++++
> >  CONTRIBUTING.md |  3 +++
> >  LICENSE         | 51 ++++++++++++++++++++++++++++++++++++++
> >  Maintainers.txt | 48 +++++++++++++++++++++++++++++++++++
> >  README.md       | 66
> > +++++++++++++++++++++++++++++++++++++++++++++++++
> >  5 files changed, 174 insertions(+)
> >  create mode 100644 .gitignore
> >  create mode 100644 CONTRIBUTING.md
> >  create mode 100644 LICENSE
> >  create mode 100644 Maintainers.txt
> >  create mode 100644 README.md
> >
> > diff --git a/.gitignore b/.gitignore
> > new file mode 100644
> > index 0000000..df38443
> > --- /dev/null
> > +++ b/.gitignore
> > @@ -0,0 +1,6 @@
> > +.DS_Store
> > +*_extdep/
> > +*.pyc
> > +__pycache__/
> > +tags/
> > +.vscode/
> > diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644
> > index 0000000..39a1732
> > --- /dev/null
> > +++ b/CONTRIBUTING.md
> > @@ -0,0 +1,3 @@
> > +# Contributing to EDK Redfish Client
> > +
> > +Contributor documentation is maintained on the wiki:
> > +https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Developmen
> > +t-Process
> > diff --git a/LICENSE b/LICENSE
> > new file mode 100644
> > index 0000000..fd0e199
> > --- /dev/null
> > +++ b/LICENSE
> > @@ -0,0 +1,51 @@
> > +Copyright (c) 2021, TianoCore and contributors.  All rights reserved.
> > +
> > +SPDX-License-Identifier: BSD-2-Clause-Patent
> > +
> > +Redistribution and use in source and binary forms, with or without
> > +modification, are permitted provided that the following conditions are met:
> > +
> > +1. Redistributions of source code must retain the above copyright notice,
> > +   this list of conditions and the following disclaimer.
> > +
> > +2. Redistributions in binary form must reproduce the above copyright notice,
> > +   this list of conditions and the following disclaimer in the documentation
> > +   and/or other materials provided with the distribution.
> > +
> > +Subject to the terms and conditions of this license, each copyright
> > +holder and contributor hereby grants to those receiving rights under
> > +this license a perpetual, worldwide, non-exclusive, no-charge,
> > +royalty-free, irrevocable (except for failure to satisfy the conditions
> > +of this license) patent license to make, have made, use, offer to sell,
> > +sell, import, and otherwise transfer this software, where such license
> > +applies only to those patent claims, already acquired or hereafter
> > +acquired, licensable by such copyright holder or contributor that are
> > necessarily infringed by:
> > +
> > +(a) their Contribution(s) (the licensed copyrights of copyright holders and
> > +    non-copyrightable additions of contributors, in source or binary form)
> > +    alone; or
> > +
> > +(b) combination of their Contribution(s) with the work of authorship to
> > +    which such Contribution(s) was added by such copyright holder or
> > +    contributor, if, at the time the Contribution is added, such addition
> > +    causes such combination to be necessarily infringed. The patent license
> > +    shall not apply to any other combinations which include the
> > +    Contribution.
> > +
> > +Except as expressly stated above, no rights or licenses from any
> > +copyright holder or contributor is granted under this license, whether
> > +expressly, by implication, estoppel or otherwise.
> > +
> > +DISCLAIMER
> > +
> > +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
> > CONTRIBUTORS "AS IS"
> > +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> > LIMITED TO,
> > +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
> > PARTICULAR
> > +PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
> > OR
> > +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
> > +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
> > LIMITED TO,
> > +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
> > OR
> > +PROFITS; OR BUSINESS
> > +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
> > WHETHER IN
> > +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
> > OTHERWISE)
> > +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
> > ADVISED OF
> > +THE POSSIBILITY OF SUCH DAMAGE.
> > diff --git a/Maintainers.txt b/Maintainers.txt new file mode 100644 index
> > 0000000..88fd03a
> > --- /dev/null
> > +++ b/Maintainers.txt
> > @@ -0,0 +1,48 @@
> > +EDK Redfish Client Maintainers
> > +==================
> > +
> > +This file provides information about the primary maintainers for EDK
> > +Redfish Client.
> > +
> > +In general, you should not privately email the maintainer. You should
> > +email the edk2-devel list, and Cc the package maintainers and
> > +reviewers.
> > +
> > +If the package maintainer wants to hand over the role to other people,
> > +the package maintainer should send the patch to update Maintainers.txt
> > +with new maintainer, and the new maintainer should follow up with an
> > +Acked-by or a Reviewed-by.
> > +
> > +Descriptions of section entries:
> > +
> > +  L: Mailing list that is relevant to this area (default is edk2-devel)
> > +     Patches and questions should be sent to the email list.
> > +  M: Package Maintainer: Cc address for patches and questions. Responsible
> > +     for reviewing and pushing package changes to source control.
> > +  R: Package Reviewer: Cc address for patches and questions. Reviewers
> > help
> > +     maintainers review code, but don't have push access. A designated
> > Package
> > +     Reviewer is reasonably familiar with the Package (or some modules
> > +     thereof), and/or provides testing or regression testing for the Package
> > +     (or some modules thereof), in certain platforms and environments.
> > +  F: Files and directories with wildcard patterns.
> > +     A trailing slash includes all files and subdirectory files.
> > +     F:   MdeModulePkg/   all files in and below MdeModulePkg
> > +     F:   MdeModulePkg/*  all files in MdeModulePkg, but not below
> > +     F:   */Pci/*         all files in a directory called Pci, at any depth in
> > +                          the hierarchy, but not below
> > +     One pattern per line.  Multiple F: lines per section acceptable.
> > +
> > +  Filenames not caught by any F: rule get matched as being located in
> > + the top-  level directory. (Internally, the script looks for a match
> > + called '<default>',  so please don't add a file called that in the
> > + top-level directory.)
> > +
> > +EDK Redfish Client
> > +------
> > +L: https://edk2.groups.io/g/devel/
> > +T: git - https://github.com/tianocore/edk2-redfish-client.git
> > +
> > +RedfishClientPkg: Redfish client related modules
> > +F: RedfishClientPkg/
> > +M: Abner Chang <abner.chang@amd.com> [changab]
> > +M: Nickle Wang <nicklew@nvidia.com> [nicklela]
> > +R: Igor Kulchytskyy <igork@ami.com> [igorkulchytskyy]
> > diff --git a/README.md b/README.md
> > new file mode 100644
> > index 0000000..4dfa2c6
> > --- /dev/null
> > +++ b/README.md
> > @@ -0,0 +1,66 @@
> > +# Tianocore Redfish Client
> > +This repository holds EDKII Redfish client libraries, drivers and applications.
> > +EDKII Redfish client work with EDKII
> > +[RedfishPkg](https://github.com/tianocore/edk2/tree/master/RedfishPkg),
> > +and provides the functionality to support Redfish service hosted by Board
> > Management Controller (BMC) in server.
> > +Please check
> > +[Readme.md](https://github.com/tianocore/edk2/blob/master/RedfishPk
> > g/Readme.md) for the design of UEFI Redfish EDK2 implementation.
> > +
> > +# License
> > +The majority of the content in the EDK Redfish Client open source
> > +project uses a [BSD-2-Clause Plus Patent License](LICENSE).
> > +
> > +# Maintainers
> > +
> > +See [Maintainers.txt](Maintainers.txt).
> > +
> > +# Contributing
> > +
> > +The patch review process would be the same as edk2, and adding prefix
> > +**[edk2-redfish-client]** specifically for the patches against
> > +edk2-redfish-client repository. For more details, please see
> > [CONTRIBUTING.md](CONTRIBUTING.md).
> > +
> > +# How to build (Ubuntu Environment)
> > +## Prerequisite
> > +### Install packages
> > +```
> > +apt-get update; apt-get install install gcc g++ make uuid-dev nasm ```
> > +If the `nasm` installed above shows build error during build process,
> > +we need to install newer version of `nasm` manually:
> > +- Download `nasm`
> > +  ```
> > +  wget https://www.nasm.us/pub/nasm/releasebuilds/2.15rc12/nasm-
> > 2.15rc12.tar.gz"
> > +  ```
> > +- Extract file
> > +  ```
> > +  tar zxvf nasm-2.15rc12.tar.gz"
> > +  ```
> > +- Build and install `nasm`
> > +  ```
> > +  cd nasm-2.15rc12
> > +  ./configure --prefix=/usr
> > +  sudo make install
> > +  ```
> > +- Check to see if `nasm` reports desired version or not
> > +  ```
> > +  nasm -v
> > +  ```
> > +### Build EDKII base tools
> > +- Initial submodule (skip this if you already did this)
> > +  ```
> > +  git submodule update --init
> > +  ```
> > +- Build base tools
> > +  ```
> > +  cd BaseTools
> > +  make
> > +  ```
> > +## Build RedfishClientPkg
> > +In order to reference RedfishClientPkg, we need to set `PACKAGES_PATH`
> > +and specify the location of edk2-redfish-client repository.
> > +```
> > +export PACKAGES_PATH=$PWD/edk2:$PWD/edk2-redfish-client
> > +cd $PWD/edk2
> > +. ./edksetup.sh
> > +build -p RedfishClientPkg/RedfishClientPkg.dsc -t GCC5 -a X64 ```
> > --
> > 2.17.1
> >
> >
> >
> > 
> >